types.core.ImagingPlane - MATLAB File Help
types.core.ImagingPlane
  ImagingPlane An imaging plane and its metadata.
Class Details
Superclasses types.core.NWBContainer, types.untyped.GroupClass
Sealed false
Construct on load false
Constructor Summary
ImagingPlane Constructor for ImagingPlane 
Property Summary
description Description of the imaging plane. 
device Link to the Device object that was used to record from this electrode. 
excitation_lambda Excitation wavelength, in nm. 
grid_spacing Space between pixels in (x, y) or voxels in (x, y, z) directions, in the specified unit. Assumes imaging plane is a regular grid. See also reference_frame to interpret the grid. 
grid_spacing_unit Measurement units for grid_spacing. The default value is 'meters'. 
imaging_rate Rate that images are acquired, in Hz. If the corresponding TimeSeries is present, the rate should be stored there instead. 
indicator Calcium indicator. 
location Location of the imaging plane. Specify the area, layer, comments on estimation of area/layer, stereotaxic coordinates if in vivo, etc. Use standard atlas names for anatomical regions when possible. 
manifold DEPRECATED Physical position of each pixel. 'xyz' represents the position of the pixel relative to the defined coordinate space. Deprecated in favor of origin_coords and grid_spacing. 
manifold_conversion Scalar to multiply each element in data to convert it to the specified 'unit'. If the data are stored in acquisition system units or other units that require a conversion to be interpretable, multiply the data by 'conversion' to convert the data to the specified 'unit'. e.g. if the data acquisition system stores values in this object as pixels from x = -500 to 499, y = -500 to 499 that correspond to a 2 m x 2 m range, then the 'conversion' multiplier to get from raw data acquisition pixel units to meters is 2/1000. 
manifold_unit Base unit of measurement for working with the data. The default value is 'meters'. 
opticalchannel An optical channel used to record from an imaging plane. 
origin_coords Physical location of the first element of the imaging plane (0, 0) for 2-D data or (0, 0, 0) for 3-D data. See also reference_frame for what the physical location is relative to (e.g., bregma). 
origin_coords_unit Measurement units for origin_coords. The default value is 'meters'. 
reference_frame Describes reference frame of origin_coords and grid_spacing. For example, this can be a text description of the anatomical location and orientation of the grid defined by origin_coords and grid_spacing or the vectors needed to transform or rotate the grid to a common anatomical axis (e.g., AP/DV/ML). This field is necessary to interpret origin_coords and grid_spacing. If origin_coords and grid_spacing are not present, then this field is not required. For example, if the microscope takes 10 x 10 x 2 images, where the first value of the data matrix (index (0, 0, 0)) corresponds to (-1.2, -0.6, -2) mm relative to bregma, the spacing between pixels is 0.2 mm in x, 0.2 mm in y and 0.5 mm in z, and larger numbers in x means more anterior, larger numbers in y means more rightward, and larger numbers in z means more ventral, then enter the following -- origin_coords = (-1.2, -0.6, -2) grid_spacing = (0.2, 0.2, 0.5) reference_frame = "Origin coordinates are relative to bregma. First dimension corresponds to anterior-posterior axis (larger index = more anterior). Second dimension corresponds to medial-lateral axis (larger index = more rightward). Third dimension corresponds to dorsal-ventral axis (larger index = more ventral)." 
Method Summary
  addlistener Add listener for event. 
  delete Delete a handle object. 
  eq == (EQ) Test handle equality. 
  export find reference properties 
  findobj Find objects matching specified conditions. 
  findprop Find property of MATLAB handle object. 
  ge >= (GE) Greater than or equal relation for handles. 
  gt > (GT) Greater than relation for handles. 
Sealed   isvalid Test handle validity. 
  le <= (LE) Less than or equal relation for handles. 
  listener Add listener for event without binding the listener to the source object. 
  loadAll  
  lt < (LT) Less than relation for handles. 
  ne ~= (NE) Not equal relation for handles. 
  notify Notify listeners of event. 
  validate_description  
  validate_device  
  validate_excitation_lambda  
  validate_grid_spacing  
  validate_grid_spacing_unit  
  validate_imaging_rate  
  validate_indicator  
  validate_location  
  validate_manifold  
  validate_manifold_conversion  
  validate_manifold_unit  
  validate_opticalchannel  
  validate_origin_coords  
  validate_origin_coords_unit  
  validate_reference_frame  
Event Summary