allensdk.brain_observatory.ecephys.write_nwb.schemas module

class allensdk.brain_observatory.ecephys.write_nwb.schemas.BaseBehaviorSessionDataSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.BaseNeuropixelsSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: ArgSchema

Base schema for writing NWB files for projects with behavior + ecephys

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.Channel(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
set_field_defaults(data, **kwargs)[source]
set_impedence_default(data, **kwargs)[source]
class allensdk.brain_observatory.ecephys.write_nwb.schemas.InvalidEpoch(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.Lfp(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.OutputSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.Probe(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.ProbeOutputs(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.SessionMetadata(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.Unit(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: RaisingSchema

dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.ecephys.write_nwb.schemas.VCNInputSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)[source]

Bases: BaseNeuropixelsSchema

Input schema for visual coding neuropixels project

class Meta[source]

Bases: object

unknown = 'raise'
dump_fields: Dict[str, ma_fields.Field]
exclude: set[Any] | MutableSet[Any]
fields: Dict[str, ma_fields.Field]

Dictionary mapping field_names -> Field objects

load_fields: Dict[str, ma_fields.Field]
opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>