Exoplanet Class

The exoplanet module of exoSpin:

ExoSpin - Exoplanet Class

class exoplanet_class.Exoplanet(planet_name, io, radius, vsini, omega_o, period, mass)

Initialize every parameters for the Exoplanet class object.

Parameters:

• planet_name (str) – Name of the exoplanet.

• io (numpy.ndarray) – 1D array representing data of the orbital inclination system.

• radius (astropy.units.quantity.Quantity) – 1D array representing data of the exoplanet’s radius.

• vsini (astropy.units.quantity.Quantity) – 1D array representing data of the exoplanet’s rotational velocity.

• omega_o (numpy.ndarray) – 1D array representing data of the exoplanet’s sky projected inclination.

• period (astropy.units.quantity.Quantity) – a quantity representing the exoplanet’s period.

• mass (astropy.units.quantity.Quantity) – a quantity representing the exoplanet’s mass.

planet_name

Name of the exoplanet.

Type:

str

io

1D array representing data of the orbital inclination system.

Type:

numpy.ndarray

radius

1D array representing data of the exoplanet’s radius.

Type:

astropy.units.quantity.Quantity

vsini

1D array representing data of the exoplanet’s rotational velocity.

Type:

astropy.units.quantity.Quantity

omega_o

1D array representing data of the exoplanet’s sky projected inclination.

Type:

numpy.ndarray

omega_p

1D array representing data of the exoplanet’s sky projected spin-axis.

Type:

numpy.ndarray

period

a quantity representing the exoplanet’s period.

Type:

astropy.units.quantity.Quantity

mass

a quantity representing the exoplanet’s mass.

Type:

astropy.units.quantity.Quantity

velocity

1D array representing data of the exoplanet’s velocity computed with radius and period data.

Type:

numpy.ndarray

v_lim

a quantity representing the velocity break limit of the exoplanet.

Type:

astropy.units.quantity.Quantity

P_lim

a quantity representing the period break limit of the exoplanet.

Type:

astropy.units.quantity.Quantity

lambda_

1D array representing data of the sky projected obliquity.

Type:

numpy.ndarray

ip

1D array representing data of the exoplanet’s spin axis.

Type:

numpy.ndarray

proj_obli

1D array representing data of the exoplanet’s projected obliquity.

Type:

numpy.ndarray

true_obli

1D array representing data of the exoplanet’s true obliquity.

Type:

numpy.ndarray

ip_pdf_saved

a Plot that contains PDF data for spin axis

Type:

Plot

hist(arg, color_graph='blue')

Compute and save histogram plot of a exoplanet parameter.

Parameters:

• arg (str) – a string that represents which histogram to plot. Possible values : {‘Orbital inclination’,’Radius’,’Rotational velocity’,’Sky projected inclination’,’Sky projected spin axis’,’Sky projected obliquity’,’Spin axis’,’Project obliquity’,’True obliquity’}

• color_graph (str) – a string to set the graph color.

Returns:

a Plot object that has every important parameters of the histogram

Return type:

Plot

Raises:

If the arg is not in the excepted values. –

pdf(arg, color_graph='blue')

Compute and save the PDF plot of a exoplanet parameter.

Parameters:

• arg (str) – a string that represents which histogram to plot.{‘Orbital inclination’,’Radius’,’Rotational velocity’,’Sky projected inclination’,’Sky projected spin axis’,’Sky projected obliquity’,’Spin axis - easy’,’Spin axis - complex’,’Projected obliquity - easy’,’Projected obliquity - complex’,’True obliquity - easy’,’True obliquity - complex’}

• color_graph (str) – a string to set the graph color.

Returns:

a Plot object that has every important parameters of the histogram

Return type:

Plot

Raises:

If the arg is not in the excepted values. –

plot_obli(arg)

Plot the obliquity of the exoplanet.

Parameters:

• arg (str) – a string that describe which histogram to plot. Possible values : {‘easy’,’complex’}

• color_graph (str) – a string to set the graph color.

Raises:

If arg is not in the excepted values –

proj_obli_data()

Compute the projected obliquity data of the exoplanet

set_data(arg, data)

Set new data for an exoplanet parameter.

Parameters:

• arg (str) – a string that describe which histogram to plot. { ‘Orbital inclination’, ‘Radius’, ‘Rotational velocity’, ‘Sky projected inclination’, ‘Sky projected spin-orbit’, ‘Spin axis’, ‘Project obliquity’, ‘True obliquity’ }

• data – a input that contains the data to be set

Raises:

If the arg is not in the excepted values and if data and self attributes don't have the same type –

spin_axis_data()

Compute the spin axis data of the exoplanet

true_obli_data()

Compute the true obliquity data of the exoplanet