IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 9710


Ignore:
Timestamp:
Oct 20, 2006, 6:02:36 PM (20 years ago)
Author:
Paul Price
Message:

Documenting, adding const

Location:
trunk/psModules/src/camera
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/psModules/src/camera/pmFPAview.c

    r9363 r9710  
    33 *  @author EAM, IfA
    44 *
    5  *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
    6  *  @date $Date: 2006-10-06 21:45:58 $
     5 *  @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
     6 *  @date $Date: 2006-10-21 04:02:36 $
    77 *
    88 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    6868}
    6969
    70 pmChip *pmFPAviewThisChip(const pmFPAview *view, pmFPA *fpa)
     70pmChip *pmFPAviewThisChip(const pmFPAview *view, const pmFPA *fpa)
    7171{
    7272    PS_ASSERT_PTR_NON_NULL(view, NULL);
    … …  
    8686}
    8787
    88 pmChip *pmFPAviewNextChip(pmFPAview *view, pmFPA *fpa, int nStep)
     88pmChip *pmFPAviewNextChip(pmFPAview *view, const pmFPA *fpa, int nStep)
    8989{
    9090    PS_ASSERT_PTR_NON_NULL(view, NULL);
    … …  
    120120}
    121121
    122 pmCell *pmFPAviewThisCell(const pmFPAview *view, pmFPA *fpa)
     122pmCell *pmFPAviewThisCell(const pmFPAview *view, const pmFPA *fpa)
    123123{
    124124    PS_ASSERT_PTR_NON_NULL(view, NULL);
    … …  
    140140}
    141141
    142 pmCell *pmFPAviewNextCell (pmFPAview *view, pmFPA *fpa, int nStep)
     142pmCell *pmFPAviewNextCell (pmFPAview *view, const pmFPA *fpa, int nStep)
    143143{
    144144    PS_ASSERT_PTR_NON_NULL(view, NULL);
    … …  
    176176}
    177177
    178 pmReadout *pmFPAviewThisReadout (const pmFPAview *view, pmFPA *fpa)
     178pmReadout *pmFPAviewThisReadout (const pmFPAview *view, const pmFPA *fpa)
    179179{
    180180    PS_ASSERT_PTR_NON_NULL(view, NULL);
    … …  
    196196}
    197197
    198 pmReadout *pmFPAviewNextReadout (pmFPAview *view, pmFPA *fpa, int nStep)
     198pmReadout *pmFPAviewNextReadout (pmFPAview *view, const pmFPA *fpa, int nStep)
    199199{
    200200    PS_ASSERT_PTR_NON_NULL(view, NULL);
    … …  
    231231}
    232232
    233 pmHDU *pmFPAviewThisHDU(const pmFPAview *view, pmFPA *fpa)
     233pmHDU *pmFPAviewThisHDU(const pmFPAview *view, const pmFPA *fpa)
    234234{
    235235    PS_ASSERT_PTR_NON_NULL(view, NULL);
    … …  
    252252}
    253253
    254 pmHDU *pmFPAviewThisPHU(const pmFPAview *view, pmFPA *fpa)
     254pmHDU *pmFPAviewThisPHU(const pmFPAview *view, const pmFPA *fpa)
    255255{
    256256    PS_ASSERT_PTR_NON_NULL(view, NULL);

  • trunk/psModules/src/camera/pmFPAview.h

    r9584 r9710  
    1 /** @file  pmFPAview.h
    2 *
    3 * @brief Tools to manipulate the FPA structure elements.
    4 *
    5 *  @ingroup AstroImage
    6 *
    7 *  @author EAM, IfA
    8 *
    9 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
    10 *  @date $Date: 2006-10-17 00:33:56 $
    11 *
    12 *  Copyright 2004-2005 Institute for Astronomy, University of Hawaii
    13 */
     1/// @file pmFPA.h
     2///
     3/// @brief Tools to manipulate the FPA structure elements.
     4///
     5/// @ingroup Camera
     6///
     7/// @author Eugene Magnier, IfA
     8///
     9/// @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
     10/// @date $Date: 2006-10-21 04:02:36 $
     11///
     12/// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
     13///
    1414
    1515#ifndef PM_FPA_VIEW_H
    … …  
    1919#include "pmFPALevel.h"
    2020
    21 /// @addtogroup AstroImage
    22 /// @{
    23 
     21/// Identifier for FPA components
     22///
     23/// This structure allows the identification of a single component of the focal plane hierarchy (or multiple,
     24/// if we consider selecting all those components below the selected component).  Components are identified on
     25/// the basis of their chip, cell, readout index.  An index of -1 means all components at that level.
     26/// Additionally, since readouts may be read piecemeal, there are additional indices for these.
    2427typedef struct
    2528{
    26     int chip;                           // Number of the chip, or -1 for all
    27     int cell;                           // Number of the cell, or -1 for all
    28     int readout;                        // Number of the readout, or -1 for all
    29     int nRows;                          // Maximum number of rows per readout segment read, or 0 for all
    30     int iRows;                          // Starting point for this read
     29    int chip;                           ///< Number of the chip, or -1 for all
     30    int cell;                           ///< Number of the cell, or -1 for all
     31    int readout;                        ///< Number of the readout, or -1 for all
     32    int nRows;                          ///< Maximum number of rows per readout segment read, or 0 for all
     33    int iRows;                          ///< Starting point for this read
    3134}
    3235pmFPAview;
    3336
    34 // allocate a pmFPAview structure for this fpa and camera
    35 pmFPAview *pmFPAviewAlloc (int nRows);
     37/// Allocator for pmFPAview
     38pmFPAview *pmFPAviewAlloc(int nRows     ///< Maximum number of rows per readout segment read, or 0 for all
     39                         );
    3640
    37 // Reset a view
    38 bool pmFPAviewReset(pmFPAview *view);
     41/// Reset a view to select all components
     42bool pmFPAviewReset(pmFPAview *view     ///< View to reset
     43                   );
    3944
    40 // determine the current view level
    41 pmFPALevel pmFPAviewLevel (const pmFPAview *view);
     45/// Determine the current view level
     46///
     47/// Returns the level appropriate for the view
     48pmFPALevel pmFPAviewLevel(const pmFPAview *view ///< View to examine
     49                         );
    4250
    43 // return the currently selected chip for this view
    44 pmChip *pmFPAviewThisChip (const pmFPAview *view, pmFPA *fpa);
     51// Lookups
    4552
    46 // advance view to the next chip
    47 pmChip *pmFPAviewNextChip (pmFPAview *view, pmFPA *fpa, int nStep);
     53/// Return the currently selected chip for this view
     54///
     55/// Returns NULL if the selection is not specific or invalid
     56pmChip *pmFPAviewThisChip(const pmFPAview *view, ///< Current view
     57                          const pmFPA *fpa ///< FPA containing chip
     58                         );
    4859
    49 // return the currently selected cell for this view
    50 pmCell *pmFPAviewThisCell (const pmFPAview *view, pmFPA *fpa);
     60/// Return the currently selected cell for this view
     61///
     62/// Returns NULL if the selection is not specific or invalid
     63pmCell *pmFPAviewThisCell(const pmFPAview *view, ///< Current view
     64                          const pmFPA *fpa ///< FPA containing cell
     65                         );
    5166
    52 // advance view to the next cell
    53 pmCell *pmFPAviewNextCell (pmFPAview *view, pmFPA *fpa, int nStep);
     67/// Return the currently selected readout for this view
     68///
     69/// Returns NULL if the selection is not specific or invalid
     70pmReadout *pmFPAviewThisReadout(const pmFPAview *view, ///< Current view
     71                                const pmFPA *fpa ///< FPA containing readout
     72                               );
    5473
    55 // return the currently selected readout for this view
    56 pmReadout *pmFPAviewThisReadout (const pmFPAview *view, pmFPA *fpa);
     74// Incrementors
    5775
    58 // advance view to the next readout
    59 pmReadout *pmFPAviewNextReadout (pmFPAview *view, pmFPA *fpa, int nStep);
     76/// Advance view to the next chip
     77///
     78/// Returns NULL if there is no next
     79pmChip *pmFPAviewNextChip(pmFPAview *view, ///< Current view
     80                          const pmFPA *fpa, ///< FPA containing chips
     81                          int nStep     ///< Number of chips to increment
     82                         );
    6083
    61 // return the HDU corresponding to the current view
    62 pmHDU *pmFPAviewThisHDU (const pmFPAview *view, pmFPA *fpa);
    63 pmHDU *pmFPAviewThisPHU (const pmFPAview *view, pmFPA *fpa);
     84/// Advance view to the next cell
     85///
     86/// Returns NULL if there is no next
     87pmCell *pmFPAviewNextCell(pmFPAview *view, ///< Current view
     88                          const pmFPA *fpa, ///< FPA containing cells
     89                          int nStep     ///< Number of cells to increment
     90                         );
    6491
    65 # endif
     92/// Advance view to the next readout
     93///
     94/// Returns NULL if there is no next
     95pmReadout *pmFPAviewNextReadout(pmFPAview *view, ///< Current view
     96                                const pmFPA *fpa, ///< FPA containing readouts
     97                                int nStep ///< Number of readouts to increment
     98                               );
     99
     100/// Return the HDU corresponding to the current view
     101///
     102/// Uses the pmHDUFrom* functions, combined with the view.
     103pmHDU *pmFPAviewThisHDU(const pmFPAview *view, ///< Current view
     104                        const pmFPA *fpa ///< FPA for view
     105                       );
     106
     107/// Return the blank Primary HDU corresponding to the current view, if any
     108///
     109/// Similar to pmFPAviewThisHDU, except returns NULL if no HDU is found, or the HDU is not a blank Primary HDU
     110pmHDU *pmFPAviewThisPHU(const pmFPAview *view, ///< Current view
     111                        const pmFPA *fpa ///< FPA for view
     112                       );
     113
     114#endif
Note: See TracChangeset for help on using the changeset viewer.