Skip to content

Project Movie

Compute Credits

This tool uses 2.0 compute credits per hour.

The Project Movie calculates a frame statistic from a microscope movie, such as the mean frame.

This may be applied to a preprocessed movie in order to generate a reference frame for the Motion Correct algorithm. Alternatively, the statistic frame may be useful as a summary of the movie data at a particular processing stage.

Inputs

Parameter Required? Default Description
Input Movie Files True N/A paths to the input movie files
Statistic Type True mean type of statistic to compute (mean, minimum, maximum, standard deviation, local correlation)

File Inputs

Source Parameter File Type File Format
Input Movie Files miniscope_movie, miniscope_movie isxd, isxc

Description

Each pixel in the statistic frame or image of a movie can be calculated individually. For example, let's consider calculating the pixel value at coordinates \((x, y)\) of the mean frame:

\[ M_\text{mean}(x, y) = \underset { t = t_\text{from} ... t_\text{to} } { \mathrm{mean} } \left[ M_t(x, y) \right] \]

where \(M_{t}\) is frame \(t\) of a movie \(M\), \(t_\text{from} = 0\), and \(t_\text{to} = T\) where \(T\) is the total number of frames in the movie. Any invalid frames, like dropped frames, are ignored in the calculation. This calculation is performed for each pixel in the frame to generate the final result. The minimum and maximum statistic image are calculated in the same way.

If you select local correlation as Statistic Type, Project Movie will compute the local correlation image the following way:

  • for each pixel (pixel of interest, POI) in the field of view (FoV), this tool will load the POI's trace across time along with traces from its (up to) 8 neighboring pixels
  • it will then compute correlation coefficients between the POI and each of its neighbors
  • the POI will take as value the maximum correlation coefficient
  • this process is repeated for all pixels of the FoV, to compose the local correlation image

This projection image is especially useful as a template image in the CaImAn Multi-Session Registration tool.

Compute-intensive task

Computing local correlation requires substantially more RAM resources than computing the other statistics, therefore please make sure to increase compute resources by selecting an instance with at least 3x as much RAM as the movie size (e.g., for a 6 GB movie, select an instance with 32 GB RAM (i.e., the smallest instance offering more 18 GB RAM)).