ifw-ccf  2.0.0
Functions
fits_cube_gen.lib Namespace Reference

Functions

def gen_cube (size, noise, magnitude, data_type, nb_of_images, max_shift_per_image, max_total_shift, output_file)
 Generate a FITS image cube for test purposes. More...
 
def execute_command_line (argv)
 Handle command line. More...
 

Function Documentation

◆ execute_command_line()

def fits_cube_gen.lib.execute_command_line (   argv)

Handle command line.

◆ gen_cube()

def fits_cube_gen.lib.gen_cube (   size,
  noise,
  magnitude,
  data_type,
  nb_of_images,
  max_shift_per_image,
  max_total_shift,
  output_file 
)

Generate a FITS image cube for test purposes.

The test cube will be based on an artificial star, with Gaussian distribution.

size Size of the image frames in the cube (string, NX x NY, e.g. "512x512").

noise Level of background noise to apply to each frame in the cube (int).

magnitude Maximum value of the artificial star in accordance with the output data type (int).

data_type Data type in the output data cube (string, "INT16", "INT32", "FLOAT", "DOUBLE").

nb_of_images Number of image frames in the output data cube (int).

max_shift_per_image Maximum shift of the artificial star from image frame to image frame (int).

max_total_shift The total maximum shift allowed for the artificial star in the cube (int).

output_file Name of the output FITS cube file (string).