mcfacts.objects.agnobject.AGNBlackHole

class mcfacts.objects.agnobject.AGNBlackHole(mass=array([], dtype=float64), gw_freq=array([], dtype=float64), gw_strain=array([], dtype=float64), bh_num=0, **kwargs)

Bases: AGNObject

A subclass of AGNObject for single black holes. It extends AGNObject and adds attributes for GW frequency and strain. This is only relevant for EMRIs and BBH, so if a value is not passed these attributes are set to -1.5. AGNBlackHole also calculates orbital angular momentum for black holes.

Creates an instance of AGNBlackHole object.

Parameters:

mass (numpy.ndarray) – black hole masses [Msun]
gw_freq (numpy.ndarray) – gravitational wave frequency [Hz]
gw_strain (numpy.ndarray) – gravitational wave strain [unitless]

__init__(mass=array([], dtype=float64), gw_freq=array([], dtype=float64), gw_strain=array([], dtype=float64), bh_num=0, **kwargs)

Creates an instance of AGNBlackHole object.

Parameters:

mass (numpy.ndarray) – black hole masses [Msun]
gw_freq (numpy.ndarray) – gravitational wave frequency [Hz]
gw_strain (numpy.ndarray) – gravitational wave strain [unitless]

Methods

`__init__`([mass, gw_freq, gw_strain, bh_num])	Creates an instance of AGNBlackHole object.
`add_blackholes`([new_mass, new_gw_freq, ...])	Append black holes to the AGNBlackHole object.
`add_objects`([new_mass, new_spin, ...])	Append new objects to the AGNObject.
`at_id_num`(id_num[, attr])	Returns the attribute at the specified ID numbers
`check_consistency`()	Prints the size of each attribute to check that everything is consistent.
`copy`()	Creates a deep copy of the AGNObject
`init_from_file`([fname])	Reads in file from previous AGNObject.
`keep_id_num`(id_num_keep)	Filters AGNObject to only keep the objects at the specified ID numbers
`keep_index`(idx_keep)	Filters AGNObject to only keep the objects at the specified indices.
`remove_id_num`([id_num_remove])	Filters AGNObject to remove the objects at the specified ID numbers
`remove_index`([idx_remove])	Removes objects at specified indices.
`return_params`()	Gets list of parameters present in object.
`return_record_array`()	Returns a numpy dictionary of all attributes in the AGNObject
`sort`([sort_attr])	Sorts all attributes of the AGNObject by the passed attribute
`to_txt`([fname, cols, extra_header])	Loads AGNObject into temporary multi-dim numpy array and then uses np.savetxt to save to file.
`unique_id_nums`()	Checks that ID numbers are unique.

__repr__()

Creates a string representation of AGNBlackHole. Prints out the number of black holes present in this instance of AGNBlackHole.

Returns:: totals – number of black holes in AGNBlackHole
Return type:: str

add_blackholes(new_mass=array([], dtype=float64), new_gw_freq=array([], dtype=float64), new_gw_strain=array([], dtype=float64), bh_num=0, **kwargs)

Append black holes to the AGNBlackHole object.

Parameters:: obj_num (int, optional) – number of black holes to be added, by default None

add_objects(new_mass=array([], dtype=float64), new_spin=array([], dtype=float64), new_spin_angle=array([], dtype=float64), new_orb_a=array([], dtype=float64), new_orb_inc=array([], dtype=float64), new_orb_ang_mom=array([], dtype=float64), new_orb_ecc=array([], dtype=float64), new_orb_arg_periapse=array([], dtype=float64), new_gen=array([], dtype=float64), new_galaxy=array([], dtype=float64), new_time_passed=array([], dtype=float64), new_id_num=array([], dtype=float64), obj_num=0)

Append new objects to the AGNObject. This method is not called directly, it is only called by the subclasses’ add methods.

Parameters:

new_mass (numpy array) – masses to be added
new_spin (numpy array) – spins to be added
new_spin_angle (numpy array) – spin angles to be added
new_orb_a (numpy array) – semi-major axes to be added
new_orb_inc (numpy array) – orbital inclinations to be added
new_orb_ang_mom (numpy array) – orbital angular momentum to be added
new_orb_ecc (numpy array) – orbital eccentricities to be added
new_orb_arg_periapse (numpy array) – orbital arguments of the periapse to be added
new_gen (numpy array) – generations to be added
new_galaxy (numpy array) – galaxy iteration to be added, set to -1 if not passed
new_time_passed (numpy array) – time passed to be added, set to -1 if not passed
new_id_num (numpy array,optional) – ID numbers to be added
obj_num (int, optional) – Number of objects to be added.

at_id_num(id_num, attr=None)

Returns the attribute at the specified ID numbers

Parameters:

id_num (numpy array or float) – ID numbers of objects to return
attr (str) – attribute to return

Returns:

val – specified attribute at specified ID numbers

Return type:

numpy array

check_consistency(): Prints the size of each attribute to check that everything is consistent. Raises an AttributeError if all arrays do not have the same length.

copy()

Creates a deep copy of the AGNObject

Parameters:: None
Returns:: copied_object – new copy of AGNObject with no references to original AGNObject
Return type:: AGNObject

init_from_file(fname=None)

Reads in file from previous AGNObject.: Not fully implemented. Would need to init AGNObject and then read from file?

Parameters:: fname (str) – file to read in

keep_id_num(id_num_keep)

Filters AGNObject to only keep the objects at the specified ID numbers

Parameters:: id_num_keep (numpy array) – ID numbers to keep, others are removed

keep_index(idx_keep)

Filters AGNObject to only keep the objects at the specified indices.

Parameters:: idx_keep (numpy array) – indices to keep, others are removed.

remove_id_num(id_num_remove=None)

Filters AGNObject to remove the objects at the specified ID numbers

Parameters:: id_num_keep (numpy array) – ID numbers to keep, others are removed

remove_index(idx_remove=None)

Removes objects at specified indices.

Parameters:: idx_remove (numpy array) – indices to remove

return_params()

Gets list of parameters present in object.

Parameters:: None
Returns:: parameters in object
Return type:: list

return_record_array()

Returns a numpy dictionary of all attributes in the AGNObject

Parameters:: None
Returns:: dat_out – dictionary array of all attributes in the AGNObject. Everything is written as a float.
Return type:: numpy dictionary

sort(sort_attr=None)

Sorts all attributes of the AGNObject by the passed attribute

Parameters:: sort_attr (AGNObject attribute array) – array to sort the AGNObject by

to_txt(fname=None, cols=None, extra_header=None)

Loads AGNObject into temporary multi-dim numpy array and then uses np.savetxt to save to file. Avoids the issue of pandas writing non-values as blanks instead of NaNs.

Parameters:

fname (str) – filename including path
cols (array of str) – array of header names to re-order or cut out columns, optional
extra_header (str) – extra information to go a line above the column names, optional

unique_id_nums(): Checks that ID numbers are unique.