models

digraph inheritanceacc1831564 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "Autopilot_Type" [URL="../../../root/index.html#autopilot.root.Autopilot_Type",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Root autopilot model for types"]; "interfaces.tables.H5F_Group" [URL="../../interfaces/tables.html#autopilot.data.interfaces.tables.H5F_Group",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Description of a pytables group and its location"]; "interfaces.tables.H5F_Node" -> "interfaces.tables.H5F_Group" [arrowsize=0.5,style="setlinewidth(0.5)"]; "interfaces.tables.H5F_Node" [URL="../../interfaces/tables.html#autopilot.data.interfaces.tables.H5F_Node",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for H5F Nodes"]; "modeling.base.Node" -> "interfaces.tables.H5F_Node" [arrowsize=0.5,style="setlinewidth(0.5)"]; "modeling.base.Attributes" [URL="../../modeling/index.html#autopilot.data.modeling.base.Attributes",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A set of attributes that is intended to have a single representation per usage:"]; "modeling.base.Data" -> "modeling.base.Attributes" [arrowsize=0.5,style="setlinewidth(0.5)"]; "modeling.base.Data" [URL="../../modeling/index.html#autopilot.data.modeling.base.Data",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The top-level container for Data."]; "Autopilot_Type" -> "modeling.base.Data" [arrowsize=0.5,style="setlinewidth(0.5)"]; "modeling.base.Group" [URL="../../modeling/index.html#autopilot.data.modeling.base.Group",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A generic representation of a \"Group\" if present in a given interface."]; "Autopilot_Type" -> "modeling.base.Group" [arrowsize=0.5,style="setlinewidth(0.5)"]; "modeling.base.Node" [URL="../../modeling/index.html#autopilot.data.modeling.base.Node",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Abstract representation of a Node in a treelike or linked data structure."]; "Autopilot_Type" -> "modeling.base.Node" [arrowsize=0.5,style="setlinewidth(0.5)"]; "modeling.base.Schema" [URL="../../modeling/index.html#autopilot.data.modeling.base.Schema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A special type of type intended to be a representation of an"]; "Autopilot_Type" -> "modeling.base.Schema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "modeling.base.Table" [URL="../../modeling/index.html#autopilot.data.modeling.base.Table",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Tabular data: each field will have multiple values -- in particular an equal number across fields."]; "modeling.base.Data" -> "modeling.base.Table" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.biography.Baselines" [URL="../biography.html#autopilot.data.models.biography.Baselines",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Baseline health measurements for animal care regulation. In the future this"]; "modeling.base.Data" -> "models.biography.Baselines" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.biography.Biography" [URL="../biography.html#autopilot.data.models.biography.Biography",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The combined biographical, health, genetic, and other details that define an experimental subject."]; "modeling.base.Attributes" -> "models.biography.Biography" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.biography.Breeding" [URL="../biography.html#autopilot.data.models.biography.Breeding",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Information about the breeding conditions of the subject"]; "modeling.base.Data" -> "models.biography.Breeding" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.biography.Enclosure" [URL="../biography.html#autopilot.data.models.biography.Enclosure",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Where does the subject live?"]; "modeling.base.Data" -> "models.biography.Enclosure" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.biography.Gene" [URL="../biography.html#autopilot.data.models.biography.Gene",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An individual (trans)gene that an animal may have."]; "modeling.base.Data" -> "models.biography.Gene" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.biography.Genotype" [URL="../biography.html#autopilot.data.models.biography.Genotype",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Genotyping information, information about a subject's background and (potentially multiple) :class:`.Gene` s of interest"]; "modeling.base.Data" -> "models.biography.Genotype" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.protocol.Protocol_Data" [URL="../protocol.html#autopilot.data.models.protocol.Protocol_Data",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "modeling.base.Schema" -> "models.protocol.Protocol_Data" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.protocol.Protocol_Group" [URL="../protocol.html#autopilot.data.models.protocol.Protocol_Group",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The group and subgroups for a given protocol."]; "interfaces.tables.H5F_Group" -> "models.protocol.Protocol_Group" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.protocol.Step_Data" [URL="../protocol.html#autopilot.data.models.protocol.Step_Data",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Schema for storing data for a single step of a protocol"]; "modeling.base.Schema" -> "models.protocol.Step_Data" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.protocol.Step_Group" [URL="../protocol.html#autopilot.data.models.protocol.Step_Group",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="An hdf5 group for an individual step within a protocol."]; "interfaces.tables.H5F_Group" -> "models.protocol.Step_Group" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.protocol.Task_Params" [URL="../protocol.html#autopilot.data.models.protocol.Task_Params",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass for storing task parameters"]; "Autopilot_Type" -> "models.protocol.Task_Params" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.protocol.Trial_Data" [URL="../protocol.html#autopilot.data.models.protocol.Trial_Data",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for declaring trial data."]; "modeling.base.Table" -> "models.protocol.Trial_Data" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.researcher.Researcher" [URL="../researcher.html#autopilot.data.models.researcher.Researcher",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "modeling.base.Data" -> "models.researcher.Researcher" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.subject.Hashes" [URL="../subject.html#autopilot.data.models.subject.Hashes",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Table to track changes in version over time"]; "modeling.base.Table" -> "models.subject.Hashes" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.subject.History" [URL="../subject.html#autopilot.data.models.subject.History",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Table to describe parameter and protocol change history"]; "modeling.base.Table" -> "models.subject.History" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.subject.History_Group" [URL="../subject.html#autopilot.data.models.subject.History_Group",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Group for collecting subject history tables."]; "modeling.base.Group" -> "models.subject.History_Group" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.subject.Protocol_Status" [URL="../subject.html#autopilot.data.models.subject.Protocol_Status",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Status of assigned protocol. Accessible from the :attr:`.Subject.protocol` getter/setter"]; "modeling.base.Attributes" -> "models.subject.Protocol_Status" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.subject.Subject_Schema" [URL="../subject.html#autopilot.data.models.subject.Subject_Schema",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Structure of the :class:`.Subject` class's hdf5 file"]; "modeling.base.Schema" -> "models.subject.Subject_Schema" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.subject.Subject_Structure" [URL="../subject.html#autopilot.data.models.subject.Subject_Structure",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Structure of the :class:`.Subject` class's hdf5 file"]; "modeling.base.Schema" -> "models.subject.Subject_Structure" [arrowsize=0.5,style="setlinewidth(0.5)"]; "models.subject.Weights" [URL="../subject.html#autopilot.data.models.subject.Weights",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Class to describe table for weight history"]; "modeling.base.Table" -> "models.subject.Weights" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

Specific models are then built out of the basic modeling components! This will serve as the point where data models can be added or modified by plugins (stay tuned).

Each of the modules contains several classes that are used together in some particular context:

• models.biography - Defines biographical information for an individual Subject

• models.protocol - Defines the data structure of how multiple Tasks are stacked together into a training protocol, as well as how they are represented in the Subject’s h5f file.

• models.subject - Schemas that define how the multiple models that go into a subject are combined and structured on disk

• models.researcher - Stubs for researcher information that will be used in future versions for giving explicit credit for data gathered by a particular researcher or research group…

• biography
  • SEX
  • Enclosure
    • Enclosure.box
    • Enclosure.building
    • Enclosure.room
  • Breeding
    • Breeding.parents
    • Breeding.litter
  • Gene
    • Gene.name
    • Gene.zygosity
  • Genotype
    • Genotype.strain
    • Genotype.genes
  • Baselines
    • Baselines.mass
    • Baselines.minimum_pct
    • Baselines.minimum_mass
  • Biography
    • Biography.id
    • Biography.start_date
    • Biography.dob
    • Biography.sex
    • Biography.description
    • Biography.tags
    • Biography.species
    • Biography.breeding
    • Biography.enclosure
    • Biography.baselines
    • Biography.genotype
    • Biography.age
• protocol
  • Task_Params
  • Trial_Data
    • Trial_Data.group
    • Trial_Data.session
    • Trial_Data.session_uuid
    • Trial_Data.trial_num
  • Step_Group
    • Step_Group.step_name
    • Step_Group.step
    • Step_Group.path
    • Step_Group.trial_data
    • Step_Group.continuous_group
  • Protocol_Group
    • Protocol_Group.protocol_name
    • Protocol_Group.protocol
    • Protocol_Group.tabs
    • Protocol_Group.steps
  • Step_Data
    • Step_Data.task
    • Step_Data.trial_data_table
    • Step_Data.trial_data
    • Step_Data.continuous_data
  • Protocol_Data
    • Protocol_Data.steps
• researcher
  • Researcher
    • Researcher.name
• subject
  • History
    • History.time
    • History.type
    • History.name
    • History.value
    • History.simple_time
  • Hashes
    • Hashes.time
    • Hashes.hash
    • Hashes.version
    • Hashes.id
  • Weights
    • Weights.start
    • Weights.stop
    • Weights.date
    • Weights.session
    • Weights.simple_time
  • History_Group
    • History_Group.history
    • History_Group.hashes
    • History_Group.weights
    • History_Group.past_protocols
  • Protocol_Status
    • Protocol_Status.current_trial
    • Protocol_Status.session
    • Protocol_Status.step
    • Protocol_Status.protocol
    • Protocol_Status.protocol_name
    • Protocol_Status.pilot
    • Protocol_Status.assigned
  • Subject_Structure
    • Subject_Structure.make()
  • Subject_Schema
    • Subject_Schema.info
    • Subject_Schema.data
    • Subject_Schema.protocol
    • Subject_Schema.past_protocols
    • Subject_Schema.history