api.rst

McsPyDataTools API Reference

McsPy

The ''McsData'' module

McsPy.McsData

RawData

Recording

Provides the content of the HDF5 mcs-hdf5-raw-recording-label in Python.

Data-Stream-Structures containing the data

Stream

AnalogStream

Provides the content of the HDF5 mcs-hdf5-raw-analogstream-label in Python.

FrameStream

Provides the content of the HDF5 mcs-hdf5-raw-framestream-label in Python.

FrameEntity

Provides the content of the HDF5 mcs-hdf5-raw-framestream-label and mcs-hdf5-raw-framestream-entity-label in Python.

EventStream

Provides the content of the HDF5 mcs-hdf5-raw-eventstream-label in Python.

EventEntity

Maps data event entity content of the HDF5 mcs-hdf5-raw-eventstream-label to Python structures.

SegmentStream

Provides the content of the HDF5 mcs-hdf5-raw-segmentstream-label in Python.

SegmentEntity

DataSubType != Average → Maps segement entity content of the HDF5 mcs-hdf5-raw-segmentstream-label to Python structures.

AverageSegmentTuple

AverageSegmentEntity

DataSubType == Average → Maps segment entity content of the HDF5 mcs-hdf5-raw-segmentstream-subtype-average-label to Python structures.

TimeStampStream

Provides the content of the HDF5 mcs-hdf5-raw-timestampstream-label in Python.

TimeStampEntity

Maps data timestamp entity data of the HDF5 mcs-hdf5-raw-timestampstream-label to Python structures.

Info-Classes containing Meta-Information for the data

Info

ChannelInfo

InfoSampledData

EventEntityInfo

SegmentEntityInfo

TimeStampEntityInfo

The ''McsCMOSMEA'' module

McsPy.McsCMOSMEA

McsCMOSMEAData

McsGroup

McsDataset

Raw Data (.cmcr) files

Acquisition

McsInfo

McsStream

McsChannelStream

McsChannelEntity

McsEventStream

McsEventEntity

McsSensorStream

McsSensorEntity

McsSpikeStream

McsSpikeEntity

McsSegmentStream

McsSegmentStreamEntity

McsTimeStampStream

McsTimeStampStreamEntity

Processed Data (.cmtr) files

NetworkExplorer

STAEntity

SpikeExplorer

SpikeSorter

SpikeSorterUnitEntity

FilterTool

ActivitySummary