allensdk.brain_observatory.ecephys.write_nwb.schemas module¶

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

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.BaseNeuropixelsSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: ArgSchema

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

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.Channel(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <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: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.Lfp(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.OutputSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.Probe(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.ProbeOutputs(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.SessionMetadata(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.Unit(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)[source]¶

Bases: RaisingSchema

dump_fields: dict[str, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶

class allensdk.brain_observatory.ecephys.write_nwb.schemas.VCNInputSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | 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, Field]¶

exclude: set[Any] | MutableSet[Any]¶

fields: dict[str, Field]¶: Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]¶

opts: Any = <marshmallow.schema.SchemaOpts object>¶