name: core.nwb.retinotopy
id: core.nwb.retinotopy
imports:
- core.nwb.base
- nwb.language
- core.nwb.retinotopy.include
- core.nwb.retinotopy
default_prefix: core.nwb.retinotopy/
classes:
  ImagingRetinotopy:
    name: ImagingRetinotopy
    description: 'Intrinsic signal optical imaging or widefield imaging for measuring
      retinotopy. Stores orthogonal maps (e.g., altitude/azimuth; radius/theta) of
      responses to specific stimuli and a combined polarity map from which to identify
      visual areas. This group does not store the raw responses imaged during retinotopic
      mapping or the stimuli presented, but rather the resulting phase and power maps
      after applying a Fourier transform on the averaged responses. Note: for data
      consistency, all images and arrays are stored in the format [row][column] and
      [row, col], which equates to [y][x]. Field of view and dimension arrays may
      appear backward (i.e., y before x).'
    is_a: NWBDataInterface
    attributes:
      name:
        name: name
        range: string
        required: true
      axis_1_phase_map:
        name: axis_1_phase_map
        description: Phase response to stimulus on the first measured axis.
        multivalued: false
        range: ImagingRetinotopy__axis_1_phase_map
        required: true
      axis_1_power_map:
        name: axis_1_power_map
        description: Power response on the first measured axis. Response is scaled
          so 0.0 is no power in the response and 1.0 is maximum relative power.
        multivalued: false
        range: ImagingRetinotopy__axis_1_power_map
        required: false
      axis_2_phase_map:
        name: axis_2_phase_map
        description: Phase response to stimulus on the second measured axis.
        multivalued: false
        range: ImagingRetinotopy__axis_2_phase_map
        required: true
      axis_2_power_map:
        name: axis_2_power_map
        description: Power response on the second measured axis. Response is scaled
          so 0.0 is no power in the response and 1.0 is maximum relative power.
        multivalued: false
        range: ImagingRetinotopy__axis_2_power_map
        required: false
      axis_descriptions:
        name: axis_descriptions
        description: Two-element array describing the contents of the two response
          axis fields. Description should be something like ['altitude', 'azimuth']
          or '['radius', 'theta'].
        multivalued: true
        range: text
        required: true
      focal_depth_image:
        name: focal_depth_image
        description: 'Gray-scale image taken with same settings/parameters (e.g.,
          focal depth, wavelength) as data collection. Array format: [rows][columns].'
        multivalued: false
        range: ImagingRetinotopy__focal_depth_image
        required: false
      sign_map:
        name: sign_map
        description: Sine of the angle between the direction of the gradient in axis_1
          and axis_2.
        multivalued: false
        range: ImagingRetinotopy__sign_map
        required: false
      vasculature_image:
        name: vasculature_image
        description: 'Gray-scale anatomical image of cortical surface. Array structure:
          [rows][columns]'
        multivalued: false
        range: ImagingRetinotopy__vasculature_image
        required: true
    tree_root: true