named_tuples#

This file contains the definition of various named tuples used by Investigator

Classes

ContinuousDimensionInfoTuple([...])

This is a named tuple that defines the additional information that can be specified for a continuous dimension

ContinuousPropertyTuple(name, unit_symbol)

This is a named tuple that defines a continuous property

DimensionPropertyNameTuple(name, property_name)

This is a named tuple that defines a dimension property

DiscreteEntryTuple(name[, color])

This is a named tuple that defines a discrete entry

DiscretePropertyTuple(name, tags)

This is a named tuple that defines a discrete property

DiscreteTagInfoTuple(index, id, name)

This is a named tuple that defines a discrete tag

InvestigationInfoTuple(id, name)

This is a named tuple that defines the basic information to identify an investigation

class cegalprizm.investigator.named_tuples.ContinuousDimensionInfoTuple(property_name: Optional[str] = None, unit_symbol: Optional[str] = None, is_logarithmic: bool = False, min: Optional[float] = None, max: Optional[float] = None)#

This is a named tuple that defines the additional information that can be specified for a continuous dimension

Create new instance of ContinuousDimensionInfoTuple(property_name, unit_symbol, is_logarithmic, min, max)

count(value, /)#: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

is_logarithmic: bool#: Alias for field number 2

max: float#: Alias for field number 4

min: float#: Alias for field number 3

property_name: str#: Alias for field number 0

unit_symbol: str#: Alias for field number 1

class cegalprizm.investigator.named_tuples.ContinuousPropertyTuple(name: str, unit_symbol: str)#

This is a named tuple that defines a continuous property

Create new instance of ContinuousPropertyTuple(name, unit_symbol)

count(value, /)#: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

name: str#: Alias for field number 0

unit_symbol: str#: Alias for field number 1

class cegalprizm.investigator.named_tuples.DimensionPropertyNameTuple(name: str, property_name: str)#

This is a named tuple that defines a dimension property

Create new instance of DimensionPropertyNameTuple(name, property_name)

count(value, /)#: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

name: str#: Alias for field number 0

property_name: str#: Alias for field number 1

class cegalprizm.investigator.named_tuples.DiscreteEntryTuple(name: str, color: Optional[Union[int, str]] = None)#

This is a named tuple that defines a discrete entry

Create new instance of DiscreteEntryTuple(name, color)

color: Union[int, str]#: Alias for field number 1

count(value, /)#: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

name: str#: Alias for field number 0

class cegalprizm.investigator.named_tuples.DiscretePropertyTuple(name: str, tags: List[Union[str, cegalprizm.investigator.named_tuples.DiscreteEntryTuple]])#

This is a named tuple that defines a discrete property

Create new instance of DiscretePropertyTuple(name, tags)

count(value, /)#: Return number of occurrences of value.

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

name: str#: Alias for field number 0

tags: List[Union[str, cegalprizm.investigator.named_tuples.DiscreteEntryTuple]]#: Alias for field number 1

class cegalprizm.investigator.named_tuples.DiscreteTagInfoTuple(index: int, id: str, name: str)#

This is a named tuple that defines a discrete tag

Create new instance of DiscreteTagInfoTuple(index, id, name)

count(value, /)#: Return number of occurrences of value.

id: str#: Alias for field number 1

index: int#: Alias for field number 0

name: str#: Alias for field number 2

class cegalprizm.investigator.named_tuples.InvestigationInfoTuple(id: str, name: str)#

This is a named tuple that defines the basic information to identify an investigation

Create new instance of InvestigationInfoTuple(id, name)

count(value, /)#: Return number of occurrences of value.

id: str#: Alias for field number 0

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

name: str#: Alias for field number 1

`ContinuousDimensionInfoTuple`([...])	This is a named tuple that defines the additional information that can be specified for a continuous dimension
`ContinuousPropertyTuple`(name, unit_symbol)	This is a named tuple that defines a continuous property
`DimensionPropertyNameTuple`(name, property_name)	This is a named tuple that defines a dimension property
`DiscreteEntryTuple`(name[, color])	This is a named tuple that defines a discrete entry
`DiscretePropertyTuple`(name, tags)	This is a named tuple that defines a discrete property
`DiscreteTagInfoTuple`(index, id, name)	This is a named tuple that defines a discrete tag
`InvestigationInfoTuple`(id, name)	This is a named tuple that defines the basic information to identify an investigation