fish2eod.data package¶
Submodules¶
fish2eod.data.load_data module¶
- fish2eod.data.load_data.get_body_data(species)¶
Load the body coordinates into a dataframe.
- Parameters:
species (
str) – Optional path to a new body specification- Return type:
DataFrame- Returns:
Body in 2 columns (x, y)
- fish2eod.data.load_data.get_eod_data(species)¶
Load the provided EOD data.
- Parameters:
species (
str) – Name of the species- Return type:
DataFrame- Returns:
EOD Data in 3 columns (x, relative phase, EOD)
fish2eod.data.settings module¶
- class fish2eod.data.settings.FishSettings(name, normal_length, head_distance, tail_distance, head_conductance, tail_conductance, organ_start, organ_length, organ_width)¶
Bases:
object- head_conductance: float¶
- head_distance: float¶
- middle_conductance(head_fraction, tail_fraction, x)¶
Compute the middle_cond which is a linear slope between head and tail.
- Return type:
float
- name: str¶
- normal_length: float¶
- organ_length: float¶
- organ_start: float¶
- organ_width: float¶
- tail_conductance: float¶
- tail_distance: float¶
fish2eod.data.species_registry module¶
- class fish2eod.data.species_registry.SpeciesData(settings, body, eod)¶
Bases:
object- body: DataFrame¶
- eod: DataFrame¶
- settings: FishSettings¶
- class fish2eod.data.species_registry.SpeciesRegistry¶
Bases:
dictCustom WORM dictionary.
- fish2eod.data.species_registry.register_species(name, body, eod, settings)¶