bidsbuilder.modules.schema_objects

class Column

Bases: nameValueBase, ColumnInterface

property Delimiter
__init__(_name, level)

Method generated by attrs for class Column.

Parameters:

  • _name (str)

  • level (str)

Return type:

None

property description

Description of the entity from schema.

property display_name

Human-readable display name from schema.

property format

Format of the entity from schema.

level: str
property name
schema: ClassVar[Namespace]
property str_name
property type

Type of the entity from schema.

property val

Public getter for the entity value.

val_checker(new_val)
Return type:

bool

Parameters:

new_val (Any)

valid_types: ClassVar = {'array': <class 'list'>, 'integer': <class 'int'>, 'number': (<class 'float'>, <class 'int'>), 'object': <class 'dict'>, 'string': <class 'str'>}
classmethod validate_object(to_validate)

validate name, if it can’t be found as a key tries against display name and value

Return type:

str

Parameters:

to_validate (str)

vectorized_val_checker(series)

Apply self.val_checker() to each value in a Series and return a boolean Series.

Return type:

Series

Parameters:

series (Series)

class Entity

Bases: nameValueBase

__init__(_name, level)

Method generated by attrs for class Entity.

Parameters:

  • _name (str)

  • level (str)

Return type:

None

property description

Description of the entity from schema.

property display_name

Human-readable display name from schema.

property format

Format of the entity from schema.

level: str
property name
schema: ClassVar[Namespace]
property str_name
property type

Type of the entity from schema.

property val

Public getter for the entity value.

valid_types: ClassVar = {'array': <class 'list'>, 'integer': <class 'int'>, 'number': (<class 'float'>, <class 'int'>), 'object': <class 'dict'>, 'string': <class 'str'>}
classmethod validate_object(to_validate)

validate name, if it can’t be found as a key tries against display name and value

Return type:

str

Parameters:

to_validate (str)

class Metadata

Bases: nameValueBase

Metadata is quite unique, mainly due to the ‘items’/’properties’ attribute

This basically allows for the value of one metadata field, to be an array, or dictionary of other metadata fields

__init__(_name, level)

Method generated by attrs for class Metadata.

Parameters:

  • _name (str)

  • level (str)

Return type:

None

property description

Description of the entity from schema.

property display_name

Human-readable display name from schema.

property format

Format of the entity from schema.

level: str
property name
schema: ClassVar[Namespace]
property str_name
property type

Type of the entity from schema.

property val

Public getter for the entity value.

valid_types: ClassVar = {'array': <class 'list'>, 'integer': <class 'int'>, 'number': (<class 'float'>, <class 'int'>), 'object': <class 'dict'>, 'string': <class 'str'>}
classmethod validate_object(to_validate)

validate name, if it can’t be found as a key tries against display name and value

Return type:

str

Parameters:

to_validate (str)

class Suffix

Bases: ValueBase

__init__(_name)

Method generated by attrs for class Suffix.

Parameters:

_name (str)

Return type:

None

property description

Description of the entity from schema.

property display_name

Human-readable display name from schema.

property name
schema: ClassVar[Namespace]
property str_name
classmethod validate_object(to_validate)

validate name, if it can’t be found as a key tries against display name and value

Return type:

str

Parameters:

to_validate (str)

class UserDefinedColumn

Bases: ColumnInterface

at the time of writing, version 1.10.1 defined in common-principles.html#tabular-files Users can define their own columns, using the following metadata:

LongName OPTIONAL string Long (unabbreviated) name of the column. Description RECOMMENDED string Free-form natural language description. The description of the column. Format OPTIONAL string Permitted formats for values in the described column. For a list of valid values for this field, see the associated glossary entry. Levels RECOMMENDED object For categorical variables: An object of possible values (keys) and their descriptions (values). Units RECOMMENDED string Measurement units for the associated variable. SI units in CMIXF formatting are RECOMMENDED (see Units). Delimiter OPTIONAL string If rows in a column may be interpreted as a lists of values, the character that separates one value from the next. TermURL RECOMMENDED string URL pointing to a formal definition of this type of data in an ontology available on the web. For example: https://www.ncbi.nlm.nih.gov/mesh/68008297 for “male”. HED OPTIONAL string or object of strings Hierarchical Event Descriptor (HED) information, see the HED Appendix for details. Maximum OPTIONAL number Maximum value a column entry is permitted to have. Minimum OPTIONAL number Minimum value a column entry is permitted to have.

Delimiter: Metadata
Description: Metadata
Format: Metadata
HED: Metadata
Levels: Metadata
LongName: Metadata
Maximum: Metadata
Minimum: Metadata
TermURL: Metadata
Units: Metadata
__init__(name, LongName, Description, Format, Levels, Units, Delimiter, TermURL, HED, Maximum, Minimum)

Method generated by attrs for class UserDefinedColumn.

Parameters:
Return type:

None

classmethod create(name, LongName=None, Description=None, Format=None, Levels=None, Units=None, Delimiter=None, TermURL=None, HED=None, Maximum=None, Minimum=None)
Return type:

UserDefinedColumn

Parameters:

  • name (str)

  • LongName (str)

  • Description (str)

  • Format (str)

  • Levels (dict)

  • Units (str)

  • Delimiter (str)

  • TermURL (str)

  • HED (str | list[str])

  • Maximum (int)

  • Minimum (int)

name: str
val_checker(new_val)
Return type:

bool

Parameters:

new_val (Any)

vectorized_val_checker(series)

Apply self.val_checker() to each value in a Series and return a boolean Series.

Return type:

Series

Parameters:

series (Series)

class raw_Datatype

Bases: ValueBase

__init__(_name)

Method generated by attrs for class raw_Datatype.

Parameters:

_name (str)

Return type:

None

property description

Description of the entity from schema.

property display_name

Human-readable display name from schema.

property name
schema: ClassVar[Namespace]
property str_name
classmethod validate_object(to_validate)

validate name, if it can’t be found as a key tries against display name and value

Return type:

str

Parameters:

to_validate (str)