pynrc.multiaccum

class pynrc.multiaccum(read_mode='RAPID', nint=1, ngroup=1, nf=1, nd1=0, nd2=0, nd3=0, nr1=1, nr2=1, **kwargs)[source]

Bases: object

A class for defining MULTIACCUM ramp settings. See NIRCam MULTIACCUM documentation for more details.

Parameters
  • read_mode (str) – NIRCam Ramp Readout mode such as ‘RAPID’, ‘BRIGHT1’, ‘DEEP8’, etc., or ‘CUSTOM’

  • nint (int) – Number of integrations (ramps).

  • ngroup (int) – Number of groups in a integration.

  • nf (int) – Number of frames per group.

  • nd1 (int) – Number of drop frame after reset (before first group read). Default=0.

  • nd2 (int) – Number of drop frames within a group (ie., groupgap).

  • nd3 (int) – Number of drop frames after final read frame in ramp. Default=1.

  • nr1 (int) – Number of reset frames within first ramp. Default=0.

  • nr2 (int) – Number of reset frames for subsequent ramps. Default=1.

Notes

NIRCam-specific readout modes

Pattern

NF

ND2

RAPID

1

0

BRIGHT1

1

1

BRIGHT2

2

0

SHALLOW2

2

3

SHALLOW4

4

1

MEDIUM2

2

8

MEDIUM8

8

2

DEEP2

2

18

DEEP8

8

12

Attributes Summary

nd1

Number of drop frame after reset (before first group read).

nd2

Number of drop frames within a group (aka, groupgap).

nd3

Number of drop frames after final read frame in ramp.

nf

Number of frames per group.

ngroup

Number of groups in a ramp (integration).

nint

Number of ramps (integrations) in an exposure.

patterns_list

Allowed NIRCam MULTIACCUM patterns

read_mode

Selected Read Mode in the patterns_list attribute.

Methods Summary

to_dict([verbose])

Export ramp settings to a dictionary.

Methods Documentation

to_dict(verbose=False)[source]

Export ramp settings to a dictionary.