Event

class kgpy.nsroc.Event(name='', color=None, time_mission=None)

Bases: Colorable, Named

Parameters:

  • name (str) –

  • color (str | None) –

  • time_mission (Quantity | None) –

__init__(name='', color=None, time_mission=None)
Parameters:

  • name (str) –

  • color (str | None) –

  • time_mission (Quantity | None) –

Return type:

None

Attributes

color

dataframe

name

time_mission

Methods

__init__([name, color, time_mission])

copy()

rtype:

typing.TypeVar(CopyableT, bound= Copyable)

copy_shallow()

rtype:

typing.TypeVar(CopyableT, bound= Copyable)

plot([ax, time_start])

rtype:

matplotlib.axes._axes.Axes

Inheritance Diagram

digraph inheritance3cfcb77ff5 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "abc.ABC" [URL="https://docs.python.org/3/library/abc.html#abc.ABC",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="Helper class that provides a standard way to create an ABC using"]; "kgpy.mixin.Colorable" [URL="kgpy.mixin.Colorable.html#kgpy.mixin.Colorable",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="Colorable(color: Optional[str] = None)"]; "kgpy.mixin.Copyable" -> "kgpy.mixin.Colorable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Copyable" [URL="kgpy.mixin.Copyable.html#kgpy.mixin.Copyable",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"]; "abc.ABC" -> "kgpy.mixin.Copyable" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Dataframable" [URL="kgpy.mixin.Dataframable.html#kgpy.mixin.Dataframable",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="This mixin class naively converts a child class to a :class:`pandas.Dataframe`."]; "kgpy.mixin.Named" [URL="kgpy.mixin.Named.html#kgpy.mixin.Named",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="Named(name: str = '')"]; "kgpy.mixin.Copyable" -> "kgpy.mixin.Named" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Dataframable" -> "kgpy.mixin.Named" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.nsroc.Event" [URL="kgpy.nsroc.Event.html#kgpy.nsroc.Event",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="Event(name: str = '', color: Optional[str] = None, time_mission: Optional[astropy.units.quantity.Quantity] = None)"]; "kgpy.mixin.Colorable" -> "kgpy.nsroc.Event" [arrowsize=0.5,style="setlinewidth(0.5)"]; "kgpy.mixin.Named" -> "kgpy.nsroc.Event" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
copy()
Return type:

typing.TypeVar(CopyableT, bound= Copyable)

Parameters:

self (CopyableT) –

copy_shallow()
Return type:

typing.TypeVar(CopyableT, bound= Copyable)

Parameters:

self (CopyableT) –

plot(ax=None, time_start=None)
Return type:

matplotlib.axes._axes.Axes

Parameters:

  • ax (Axes | None) –

  • time_start (Time | None) –

color: typing.Optional[str] = None
property dataframe: DataFrame
name: str = ''
time_mission: typing.Optional[astropy.units.quantity.Quantity] = None