Skip to content
Snippets Groups Projects
Commit d2db662a authored by Vesa Oikonen's avatar Vesa Oikonen
Browse files

updated doc

parent ee39e0e8
No related branches found
No related tags found
No related merge requests found
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
/*****************************************************************************/ /*****************************************************************************/
/** Verify if specified file name is an Analyze 7.5 file. /** Verify if specified file name is an Analyze 7.5 file.
@sa anaReadHeader, niftiExists @sa anaReadHeader, niftiExists, micropetExists
@return Returns 1 if it is Analyze, 0 if not. @return Returns 1 if it is Analyze, 0 if not.
*/ */
int anaExists( int anaExists(
...@@ -17,20 +17,19 @@ int anaExists( ...@@ -17,20 +17,19 @@ int anaExists(
const char *filename, const char *filename,
/** If file name refers to an Analyze file, then header file name will be /** If file name refers to an Analyze file, then header file name will be
written in this char pointer (space needs to allocated by caller); written in this char pointer (space needs to allocated by caller);
If header and image are combined, then this will be the name of combined If header and image are combined, then this will be the name of combined file;
file; enter NULL if not needed. */ enter NULL if not needed. */
char *hdrfile, char *hdrfile,
/** If file name refers to an Analyze file, then image file name will be /** If file name refers to an Analyze file, then image file name will be
written in this char pointer (space needs to allocated by caller); written in this char pointer (space needs to allocated by caller);
If header and image are combined, then this will be the name of combined If header and image are combined, then this will be the name of combined file;
file; enter NULL if not needed. */ enter NULL if not needed. */
char *imgfile, char *imgfile,
/** If file name refers to an Analyze file, and if SIF exists, then SIF file name /** If file name refers to an Analyze file, and if SIF exists, then SIF file name
will be written in this char pointer (space needs to allocated by caller); will be written in this char pointer (space needs to allocated by caller);
NULL if not needed. */ enter NULL if not needed. */
char *siffile, char *siffile,
/** Pointer to Analyze header, which is filled in this function; enter NULL, /** Pointer to Analyze header, which is filled in this function; enter NULL, if not needed. */
if not needed. */
ANALYZE_DSR *header, ANALYZE_DSR *header,
/** Pointer to status data; enter NULL if not needed. */ /** Pointer to status data; enter NULL if not needed. */
TPCSTATUS *status TPCSTATUS *status
...@@ -135,6 +134,7 @@ int anaExists( ...@@ -135,6 +134,7 @@ int anaExists(
/*****************************************************************************/ /*****************************************************************************/
/** Read Analyze header contents. /** Read Analyze header contents.
@sa anaExists, micropetHeaderRead
@return enum tpcerror (TPCERROR_OK when successful). @return enum tpcerror (TPCERROR_OK when successful).
*/ */
int anaReadHeader( int anaReadHeader(
......
...@@ -11,28 +11,27 @@ ...@@ -11,28 +11,27 @@
/** Verify if specified file name is a NIfTI file. /** Verify if specified file name is a NIfTI file.
@remark Currently only NIfTI-1 is supported. @remark Currently only NIfTI-1 is supported.
@todo Support for NIfTI-2. @todo Support for NIfTI-2.
@sa niftiReadHeader, anaExists @sa niftiReadHeader, anaExists, micropetExists
@return Returns 0 if it is not NIfTI, otherwise the version of NIfTI. @return Returns 0 if it is not NIfTI, otherwise the version of NIfTI.
*/ */
int niftiExists( int niftiExists(
/** File name, either header file, image file, or base name without extensions. */ /** File name, either header file, image file, or base name without extensions. */
const char *filename, const char *filename,
/** If filename refers to a Nifti file, then header filename will be /** If file name refers to a NIfTI file, then header file name will be
written in this char pointer (space needs to allocated by caller); written in this char pointer (space needs to allocated by caller);
If header and image are combined, then this will be the name of combined If header and image are combined, then this will be the name of combined file;
file; enter NULL if not needed. */ enter NULL if not needed. */
char *hdrfile, char *hdrfile,
/** If filename refers to a Nifti file, then image filename will be /** If file name refers to a NIfTI file, then image file name will be
written in this char pointer (space needs to allocated by caller); written in this char pointer (space needs to allocated by caller);
If header and image are combined, then this will be the name of combined If header and image are combined, then this will be the name of combined file;
file; enter NULL if not needed. */ enter NULL if not needed. */
char *imgfile, char *imgfile,
/** If filename refers to a Nifti file, and if SIF exists, then SIF filename /** If file name refers to a NIfTI file, and if SIF exists, then SIF file name
will be written in this char pointer (space needs to allocated by caller); will be written in this char pointer (space needs to allocated by caller);
NULL if not needed. */ exter NULL if not needed. */
char *siffile, char *siffile,
/** Pointer to Nifti header, which is filled in this function; enter NULL, /** Pointer to NIfTI header, which is filled in this function; enter NULL, if not needed. */
if not needed. */
NIFTI_DSR *header, NIFTI_DSR *header,
/** Pointer to status data; enter NULL if not needed. */ /** Pointer to status data; enter NULL if not needed. */
TPCSTATUS *status TPCSTATUS *status
...@@ -139,7 +138,7 @@ int niftiExists( ...@@ -139,7 +138,7 @@ int niftiExists(
/** Read Nifti header contents, including 4-byte extender. /** Read Nifti header contents, including 4-byte extender.
@remark Currently does not read Nifti-1 header extension. @remark Currently does not read Nifti-1 header extension.
@todo Support for NIfTI-2. @todo Support for NIfTI-2.
@sa niftiExists, anaReadHeader @sa niftiExists, anaReadHeader, micropetHeaderRead
@return enum tpcerror (TPCERROR_OK when successful). @return enum tpcerror (TPCERROR_OK when successful).
*/ */
int niftiReadHeader( int niftiReadHeader(
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment