studynr.c File Reference

Functions for processing PET study number. More...

#include "libtpcmisc.h"

Go to the source code of this file.

Functions
int	studynr_in_fname (char *fname, char *studynr)
int	studynr_from_fname2 (char *fname, char *studynr, int force)
int	studynr_from_fname (char *fname, char *studynr)
int	studynr_match (char *studynr1, char *studynr2)
int	studynr_validity_check2 (char *studynr, int zero_ok)
int	studynr_validity_check (char *studynr)
int	studynr_rm_zeroes (char *studynr)
int	studynr_to_lowercase (char *studynr)

Detailed Description

Functions for processing PET study number.

Author

Vesa Oikonen

Definition in file studynr.c.

Function Documentation

studynr_from_fname()

int studynr_from_fname	(	char *	fname,
		char *	studynr )

Extract study number (max MAX_STUDYNR_LEN chars) from filename. This function removes initial zeroes from the number part, and converts uppercase letters to lowercase, if necessary.

Returns

0 if successful.

Parameters

fname	Filename may include path. Filename is not modified.
studynr	Pointer for the resulting study number. Memory (>=MAX_STUDYNR_LEN+1 chars) for it must be allocated before calling this.

Definition at line 119 of file studynr.c.

  {
  return studynr_from_fname2(fname, studynr, 0);
}

Referenced by cptReadOne(), dftRead(), imgMicropetCTToEcat7(), imgMicropetPETToEcat7(), resFName2study(), resRead(), tsvRead(), and xelRead().

studynr_from_fname2()

int studynr_from_fname2	(	char *	fname,
		char *	studynr,
		int	force )

Extract study number (max MAX_STUDYNR_LEN chars) from filename.

This function removes initial zeroes from the number part, and converts uppercase letters to lowercase, if necessary.

Returns

Returns 0 if successful.

Parameters

fname	Filename, which may include the path. Filename is not modified.
studynr	Pointer for the resulting study number. Memory (>=MAX_STUDYNR_LEN+1 chars) must be allocated before calling this.
force	Validity of studynr is verified (0) or not verified (1)

Definition at line 67 of file studynr.c.

  {
  unsigned int i;
  char *cptr;
 
  //printf("studynr_from_fname2()\n");
 
  if(fname==NULL || studynr==NULL) return(1);
  strcpy(studynr, "");
 
  /* At first try if studynr_in_fname() works */
  if(studynr_in_fname(fname, studynr)==0) return(0);
 
  /* Remove path */
  cptr=strrchr(fname, '/'); if(cptr==NULL) cptr=strrchr(fname, '\\');
  if(cptr==NULL) cptr=fname; else cptr++;
  //i=strlen(cptr); if(i>MAX_STUDYNR_LEN) i=MAX_STUDYNR_LEN;
  strlcpy(studynr, cptr, MAX_STUDYNR_LEN); //studynr[i]=(char)0;
  if(force!=0) return(0);
 
  /* Check that first character is a letter */
  if(!isalpha((int)studynr[0])) {strcpy(studynr, ""); return(4);}
  /* Remove everything after the letter+digit parts */
  for(i=1; i<strlen(studynr); i++) if(!isalpha((int)studynr[i])) break;
  for(; i<strlen(studynr); i++) if(!isdigit((int)studynr[i])) break;
  studynr[i]=(char)0;
  /* Check the length of the study number */
  if(strlen(studynr)<2) {strcpy(studynr, ""); return(5);}
  /* Remove initial zeroes from the number part */
  if(studynr_rm_zeroes(studynr)!=0) {strcpy(studynr, ""); return(6);}
  /* Convert characters to lower case */
  if(studynr_to_lowercase(studynr)!=0) {strcpy(studynr, ""); return(7);}
  /* Check the validity of the study number */
  if(!studynr_validity_check(studynr)) {strcpy(studynr, ""); return(8);}
  return(0);
}

Referenced by imgGetMicropetHeader(), and studynr_from_fname().

studynr_in_fname()

int studynr_in_fname	(	char *	fname,
		char *	studynr )

Find study number (max MAX_STUDYNR_LEN chars) inside filename; Study number must contain 1-5 letters followed by 1-5 digits, if such string is not found then error code is returned.

Initial zeroes are removed if necessary and uppercase letters are changed to lowercase.

Returns

Returns 0 if successful, otherwise <>0.

Parameters

fname	Filename may include path. Filename is not modified.
studynr	Pointer to string (>=MAX_STUDYNR_LEN+1 chars) where the resulting study number is written.

Definition at line 18 of file studynr.c.

  {
  unsigned int i;
  int ret;
  char *cptr, *lptr, temp[FILENAME_MAX], temp2[FILENAME_MAX];
 
  //printf("studynr_in_filename(%s, string)\n", fname);
  if(fname==NULL || studynr==NULL) return(1);
  for(i=0; i<=MAX_STUDYNR_LEN; i++) studynr[i]=(char)0;
  /* Remove path */
  cptr=strrchr(fname, '/'); if(cptr==NULL) cptr=strrchr(fname, '\\');
  if(cptr==NULL) cptr=fname; else cptr++;
  //i=strlen(cptr); if(i>FILENAME_MAX-1) i=FILENAME_MAX-1;
  strlcpy(temp, cptr, FILENAME_MAX); lptr=temp;
  /* Verify tokens in filename whether they are valid as study number */
  cptr=strtok(lptr, "_-+{}!~.()");
  while(cptr!=NULL && !studynr[0]) {
    strcpy(temp2, cptr);
    /* Remove everything after the letter+digit parts */
    for(i=1; i<strlen(temp2); i++) if(!isalpha((int)temp2[i])) break;
    for(; i<strlen(temp2); i++) if(!isdigit((int)temp2[i])) break;
    temp2[i]=(char)0;
    /* Only then check it */
    ret=studynr_validity_check2(temp2, 1);
    if(ret==1) {
      strcpy(studynr, temp2); 
      if(studynr_rm_zeroes(studynr)!=0) strcpy(studynr, "");
      if(studynr_to_lowercase(studynr)!=0) strcpy(studynr, "");
    }
    cptr=strtok(NULL, "_-+{}!~.()");
  }
  if(!studynr[0]) return(2);
  return 0;
}

Referenced by studynr_from_fname2().

studynr_match()

int studynr_match	(	char *	studynr1,
		char *	studynr2 )

Check whether two valid study numbers are the same. If either of study numbers is shorter than the other, the end parts are compared; thus study numbers that are changed by SPM can be matched. Argument strings are not modified.

Parameters

studynr1	compared number
studynr2	compared number

Returns

1 if study numbers match exactly, 2 if the match is probable, and zero, if no match is found.

Definition at line 142 of file studynr.c.

                                                  {
  int len1, len2;
  char *cptr1, *cptr2;
 
  len1=strlen(studynr1); if(len1<2 || len1>MAX_STUDYNR_LEN) return(0);
  len2=strlen(studynr2); if(len2<2 || len2>MAX_STUDYNR_LEN) return(0);
  if(len1==len2 && strcmp(studynr1, studynr2)==0) return(1);
  if(len2>len1) cptr2=studynr2+len2-len1; else cptr2=studynr2;
  if(len1>len2) cptr1=studynr1+len1-len2; else cptr1=studynr1;
  if(strcasecmp(cptr1, cptr2)==0) return(2);
  return(0);
}

studynr_rm_zeroes()

int studynr_rm_zeroes

(

char *

studynr

)

Remove zeroes from the number part of the PET study number.

Parameters

studynr

modified study number.

Returns

nonzero in case of failure.

Definition at line 211 of file studynr.c.

                                     {
  int i, j, len;
 
  len=strlen(studynr); if(len<2) return(1);
  if(isdigit((int)studynr[0])) return(2);
  if(!isdigit((int)studynr[len-1])) return(3);
  for(i=1; i<len; i++) if(isdigit((int)studynr[i])) break;
  for(j=i; j<len; j++) if(studynr[j]!='0') break;
  if(i==j) return(0); /* no initial zeroes */
  for(;j<=len; i++, j++) studynr[i]=studynr[j];
  return(0);
}

Referenced by studynr_from_fname2(), and studynr_in_fname().

studynr_to_lowercase()

int studynr_to_lowercase

(

char *

studynr

)

Convert the PET study number letters to lowercase. Conversion is not done to non-valid study number.

Parameters

studynr

modified study number.

Returns

nonzero in case of failure.

Definition at line 233 of file studynr.c.

                                        {
  int i, len;
 
  len=strlen(studynr); if(len<2) return(1);
  if(isdigit((int)studynr[0])) return(2);
  if(!isdigit((int)studynr[len-1])) return(3);
  for(i=0; i<len; i++) {
    if(isdigit((int)studynr[i])) break;
    studynr[i]=(char)tolower((int)studynr[i]);
  }
  return(0);
}

Referenced by studynr_from_fname2(), and studynr_in_fname().

studynr_validity_check()

int studynr_validity_check

(

char *

studynr

)

Check that the argument string is a valid TPC study number.

Valid study number here is defined as containing 1-5 letters (upper- or lowercase) followed by at least 1 digit, with total length of max 10 characters.

Returns

1 if study number is valid, zero if not valid or in case of failure.

Parameters

studynr

Evaluated study number; not modified.

Definition at line 196 of file studynr.c.

  {
  return studynr_validity_check2(studynr, 0);
}

Referenced by ecat63ReadAllToImg(), ecat63ReadPlaneToImg(), imgGetEcat63MHeader(), imgGetEcat7MHeader(), and studynr_from_fname2().

studynr_validity_check2()

int studynr_validity_check2	(	char *	studynr,
		int	zero_ok )

Check that the argument string is a valid TPC study number.

Valid study number here is defined as containing 1-5 letters (upper- or lowercase) followed by at least 1 digit, with total length of max 10 characters.

Returns

1 if study number is valid, zero if not valid or in case of failure.

Parameters

studynr	String to be evaluated as study number. Not modified here.
zero_ok	Number part of study number may start with zero (1) or may not (0)

Definition at line 166 of file studynr.c.

  {
  int i, j, len;
 
  len=strlen(studynr); if(len<2 || len>MAX_STUDYNR_LEN) return(0);
  for(i=0; i<len; i++) if(!isalnum((int)studynr[i])) return(0);
  for(i=0; i<len; i++) if(!isalpha((int)studynr[i])) break;
  if(i<1 || i>5) return(0);
  if(zero_ok==0 && studynr[i]=='0') return(0); /* first digit must be >0 */
  for(j=0; (i+j)<len; j++) if(!isdigit((int)studynr[i+j])) return(0);
  //if(j<1 || j>5) return(0);
  if(j<1 || (i+j)>10) return(0);
  return(1);
}

Referenced by studynr_in_fname(), and studynr_validity_check().