Skip to content

Commit

Permalink
CVG: Consistency tidying.
Browse files Browse the repository at this point in the history
  • Loading branch information
MalcolmCurrie committed Aug 14, 2014
1 parent 27c0de2 commit 16332ee
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 22 deletions.
4 changes: 2 additions & 2 deletions libraries/cvg/cvg_assoc.f
Expand Up @@ -4,7 +4,7 @@ SUBROUTINE CVG_ASSOC( PARAM, MODE, FUNIT, BLOCKF, STATUS )
* CVG_ASSOC

* Purpose:
* Open an existing FITS file specified by an environment parameter.
* Opens an existing FITS file specified by an environment parameter.

* Language:
* Starlink Fortran 77
Expand Down Expand Up @@ -53,7 +53,7 @@ SUBROUTINE CVG_ASSOC( PARAM, MODE, FUNIT, BLOCKF, STATUS )

* Authors:
* DSB: David S. Berry (JAC, Hawaii)
* {enter_ASSOC_authors_here}
* {enter_new_authors_here}

* History:
* 20-NOV-2013 (DSB):
Expand Down
8 changes: 4 additions & 4 deletions libraries/cvg/cvg_close.f
Expand Up @@ -4,7 +4,7 @@ SUBROUTINE CVG_CLOSE( FUNIT, STATUS )
* CVG_CLOSE

* Purpose:
* Close a FITS file.
* Closes a FITS file.

* Language:
* Starlink Fortran 77
Expand Down Expand Up @@ -50,14 +50,14 @@ SUBROUTINE CVG_CLOSE( FUNIT, STATUS )

* Authors:
* DSB: David S. Berry (JAC, Hawaii)
* {enter_CLOSE_authors_here}
* {enter_new_authors_here}

* History:
* 14-NOV-2013 (DSB):
* Original version, based on code from COF_NDF2F.
* 18-NOV-2013 (DSB):
* DO not use Fotran INQUIRE statement to get information about the
* supplied unit number. Use FITSIO routines instead.
* Do not use Fortran INQUIRE statement to get information about
* the supplied unit number. Use FITSIO routines instead.
* {enter_further_changes_here}

*-
Expand Down
2 changes: 1 addition & 1 deletion libraries/cvg/cvg_new.f
Expand Up @@ -4,7 +4,7 @@ SUBROUTINE CVG_NEW( PATH, BLOCKF, OVRWRT, FUNIT, STATUS )
* CVG_NEW

* Purpose:
* Create a new FITS file and return a unit number for it.
* Creates a new FITS file and return a unit number for it.

* Language:
* Starlink Fortran 77
Expand Down
4 changes: 2 additions & 2 deletions libraries/cvg/cvg_open.f
Expand Up @@ -4,7 +4,7 @@ SUBROUTINE CVG_OPEN( PATH, MODE, FUNIT, BLOCKF, STATUS )
* CVG_OPEN

* Purpose:
* Open an existing FITS file for read or update access.
* Opens an existing FITS file for read or update access.

* Language:
* Starlink Fortran 77
Expand Down Expand Up @@ -54,7 +54,7 @@ SUBROUTINE CVG_OPEN( PATH, MODE, FUNIT, BLOCKF, STATUS )

* Authors:
* DSB: David S. Berry (JAC, Hawaii)
* {enter_OPEN_authors_here}
* {enter_newauthors_here}

* History:
* 14-NOV-2013 (DSB):
Expand Down
8 changes: 4 additions & 4 deletions libraries/cvg/cvg_pcadc.f
Expand Up @@ -208,7 +208,7 @@ SUBROUTINE CVG_PCADC( IPROV, FUNIT, STATUS )
FSTAT = CVG__FITSOK

* Check a Provenance structure was supplied.
IF( IPROV .NE. NDG__NULL ) THEN
IF ( IPROV .NE. NDG__NULL ) THEN

* Get a copy of the provenance info excluding hidden ancestors.
CALL NDG_COPYPROV( IPROV, .TRUE., IPROV2, STATUS )
Expand Down Expand Up @@ -256,7 +256,7 @@ SUBROUTINE CVG_PCADC( IPROV, FUNIT, STATUS )
CALL NDG_GETPROV( IPROV2, IDP, ANCKM, STATUS )
IF ( .NOT. AST_MAPGET0C( ANCKM, 'PATH', PATH, L,
: STATUS ) ) THEN
IF( STATUS .EQ. SAI__OK ) THEN
IF ( STATUS .EQ. SAI__OK ) THEN
STATUS = SAI__ERROR
CALL MSG_SETI( 'I', IDP )
CALL ERR_REP( ' ', 'No path found for ancestor '//
Expand Down Expand Up @@ -427,7 +427,7 @@ SUBROUTINE CVG_PCADC( IPROV, FUNIT, STATUS )
IF ( NHDU .EQ. 1 ) THEN
CALL FTGKYS( FUNIT, 'PRODUCT', PRODUC, COMENT, FSTAT )

IF( FSTAT .EQ. 202 .AND. STATUS .EQ. SAI__OK ) THEN
IF ( FSTAT .EQ. 202 .AND. STATUS .EQ. SAI__OK ) THEN
FSTAT = CVG__FITSOK
CALL FTCMSG
STATUS = SAI__ERROR
Expand Down Expand Up @@ -463,7 +463,7 @@ SUBROUTINE CVG_PCADC( IPROV, FUNIT, STATUS )
: 'Error writing CADC provenance header cards.',
: STATUS )

ELSE IF( STATUS .NE. SAI__OK ) THEN
ELSE IF ( STATUS .NE. SAI__OK ) THEN
CALL ERR_REP( ' ', 'Error writing CADC provenance header '//
: 'cards.', STATUS )
END IF
Expand Down
3 changes: 1 addition & 2 deletions libraries/cvg/cvg_scadc.f
Expand Up @@ -145,7 +145,7 @@ SUBROUTINE CVG_SCADC( IPROV, PARAM, STATUS )

* Handle a bad status. Negative values are reserved for non-fatal
* warnings.
IF( FSTAT .GT. CVG__FITSOK ) THEN
IF ( FSTAT .GT. CVG__FITSOK ) THEN
FTSUB = 'FTOPEN'
EBUFF = 'Error opening input FITS file '//FILNAM( :FLEN )//'.'

Expand All @@ -172,4 +172,3 @@ SUBROUTINE CVG_SCADC( IPROV, PARAM, STATUS )
END IF

END

42 changes: 35 additions & 7 deletions libraries/cvg/sun268.tex
Expand Up @@ -519,7 +519,7 @@ \section{\label{APP:SPEC}Routine Descriptions}
\sstroutine{
CVG\_ASSOC
}{
Open an existing FITS file specified by an environment parameter
Opens an existing FITS file specified by an environment parameter
}{
\sstdescription{
This function opens an existing FITS file with a path obtained from
Expand Down Expand Up @@ -610,10 +610,36 @@ \section{\label{APP:SPEC}Routine Descriptions}
}
}
}
\sstroutine{
CVG\_CLEAN
}{
Removes standard header cards from a FitsCHan
}{
\sstdescription{
This removes the following cards, if present, from the supplied
FitsChan: SIMPLE, BITPIX, EXTEND, NAXIS, NAXISj, all WCS related
cards.
}
\sstinvocation{
CALL CVG\_CLEAN( IPROV, FC, STATUS )
}
\sstarguments{
\sstsubsection{
FC = INTEGER (Given)
}{
The FitsChan to clean.
}
\sstsubsection{
STATUS = INTEGER (Given and Returned)
}{
The global status.
}
}
}
\sstroutine{
CVG\_CLOSE
}{
Close a FITS file
Closes a FITS file
}{
\sstdescription{
This function closes the FITS files specified by the supplied
Expand Down Expand Up @@ -713,7 +739,7 @@ \section{\label{APP:SPEC}Routine Descriptions}
CLEAR = LOGICAL (Given)
}{
Should he header be cleared before copying in the new cards?
Otherwise, the new cards are appended to the end of teh HDU.
Otherwise, the new cards are appended to the end of the HDU.
}
\sstsubsection{
FUNIT = INTEGER (Given)
Expand Down Expand Up @@ -806,8 +832,10 @@ \section{\label{APP:SPEC}Routine Descriptions}
}{
\sstdescription{
This function creates a new FITS binary table holding data copied
from an AST FitsTable. The current HDU on exit can be indicated
using MKCHDU.
from an AST FitsTable. If a binary table extension with the given
extension name already exists in the FITS file, it is replaced by
the new one. Otherwise, the table is written into the current HDU.
The current HDU on exit can be selected using MKCHDU.
}
\sstinvocation{
CALL CVG\_FT2BT( TABLE, FUNIT, EXTNAM, ASTVER, MKCHDU, STATUS )
Expand Down Expand Up @@ -971,7 +999,7 @@ \section{\label{APP:SPEC}Routine Descriptions}
\sstroutine{
CVG\_NEW
}{
Create a new FITS file and return a unit number for it
Creates a new FITS file and return a unit number for it
}{
\sstdescription{
This function creates a new FITS file with a given path, and
Expand Down Expand Up @@ -1017,7 +1045,7 @@ \section{\label{APP:SPEC}Routine Descriptions}
\sstroutine{
CVG\_OPEN
}{
Open an existing FITS file for read or update access
Opens an existing FITS file for read or update access
}{
\sstdescription{
This function opens an existing FITS file with a given path,
Expand Down

0 comments on commit 16332ee

Please sign in to comment.