TimeBinSelection¶
- class geodesic.tesseract.components.TimeBinSelection(*args, **kwargs)[source]¶
Bases:
geodesic.bases._APIObjectA description of which time bins to select from the input
- all¶
select all time bins from input
Descriptor:
_BoolDescrBoolDescr is an bool field, raises attribute error if the bool isn’t set
- Methods:
__get__: returns the bool
__set__: sets the bool after validating that it is an bool
- index¶
the index of the time bin to select
Descriptor:
_IntDescrIntDescr is an integer field, raises attribute error if the int isn’t set
- Methods:
__get__: returns the int
__set__: sets the int after validating that it is an int
- since¶
select all bins since this selection
Descriptor:
_TypeConstrainedDescrTypeConstrainedDescr creates an arbitrary field that must be constrained to a specific type
- Args:
type (type): the type you want to constrain this too
coerce (bool): the stored/retrieved result will be coerced to the type (or the first type in a tuple of types)
- Methods:
__get__: returns the object as is, AttributeError if missing
__set__: sets the object as is, validating against the specified type constraint
- until¶
select all bins before this selection
Descriptor:
_TypeConstrainedDescrTypeConstrainedDescr creates an arbitrary field that must be constrained to a specific type
- Args:
type (type): the type you want to constrain this too
coerce (bool): the stored/retrieved result will be coerced to the type (or the first type in a tuple of types)
- Methods:
__get__: returns the object as is, AttributeError if missing
__set__: sets the object as is, validating against the specified type constraint
- range¶
selection all bins in a range
Descriptor:
_TypeConstrainedDescrTypeConstrainedDescr creates an arbitrary field that must be constrained to a specific type
- Args:
type (type): the type you want to constrain this too
coerce (bool): the stored/retrieved result will be coerced to the type (or the first type in a tuple of types)
- Methods:
__get__: returns the object as is, AttributeError if missing
__set__: sets the object as is, validating against the specified type constraint
- nearest¶
select the nearest time bin
Descriptor:
_TypeConstrainedDescrTypeConstrainedDescr creates an arbitrary field that must be constrained to a specific type
- Args:
type (type): the type you want to constrain this too
coerce (bool): the stored/retrieved result will be coerced to the type (or the first type in a tuple of types)
- Methods:
__get__: returns the object as is, AttributeError if missing
__set__: sets the object as is, validating against the specified type constraint
- reduce¶
reduce along time dimension before sending to model. This will send a single time bin (NOT IMPLEMENTED)
Descriptor:
_TypeConstrainedDescrTypeConstrainedDescr creates an arbitrary field that must be constrained to a specific type
- Args:
type (type): the type you want to constrain this too
coerce (bool): the stored/retrieved result will be coerced to the type (or the first type in a tuple of types)
- Methods:
__get__: returns the object as is, AttributeError if missing
__set__: sets the object as is, validating against the specified type constraint