//
// KImageStore.h
// Original Author: James Kremer, 1997
// Adapted for Tecnai, DNM, 2-16-02
// Chnage LFileStream to CFile, substitute mFilename for mFSSpec usage
// Eliminate some functions

#ifndef KIMAGE_STORE_H
#define KIMAGE_STORE_H

/////////////////////////////////////////////////////////
// The image storage class.
// This will be derived for different 
// graphics formats.
//

#include "KImage.h"
#include "../FileOptions.h"

#define STORE_TYPE_MRC 0
#define STORE_TYPE_IMOD 1
#define STORE_TYPE_TIFF 2
#define STORE_TYPE_ADOC 3
#define STORE_TYPE_JPEG 4
#define STORE_TYPE_HDF  5
#define STORE_TYPE_IIMRC 6

class KImageStore : public KImageBase
{

protected:
	CString  mFilename;
	CFile *mFile;
	
	float mMin, mMax;
  int mStoreType;
	int mMode;
	int mPixSize;
  int mDamagedNz;
  int mIncompleteMontZ;
  int mAdocIndex;
  float mFracIntTrunc;
	FileOptions  mFileOpt;
  BOOL  mMontCoordsInMdoc;   // Flag for montage if piece coords not in header
  int mNumTitles;
  CString mTitles;
  char *mOpenMarkerExt;      // Extension if there is an .openTS file or similar temp file
  double     mMeanSum;
  int        mNumWritten;
  float      mPixelSpacing;
  float      mUpdateTimePerSect;
  bool       mHasPixelSpacing;
  int        mWrittenByVersion;
  bool       mMadeNameBeFullPath;

public:
	         KImageStore(CString inFilename);
 	         KImageStore(CFile *inFile);
	         KImageStore();
	virtual ~KImageStore(void);
	
	virtual int     Open(CFile *inFile);
	virtual int     Open(CFile *inFile, int inWidth, int inHeight, int inSections);
	virtual void    Close();
	virtual int     Flush();
	virtual CString getFilePath();
  virtual int     getStoreType() {return mStoreType;};    
	virtual int     getMode() {return mMode;};
  virtual int     GetAdocIndex(void) {return mAdocIndex;};
  virtual int     GetDamagedNz() {return mDamagedNz ; };
  virtual int     GetIncompleteMontZ() {return mIncompleteMontZ ; };

  // Methods that need to be defined appropriately in subclasses
  virtual int     AppendImage(KImage *inImage) {return 1;};
	virtual int     WriteSection(KImage * inImage, int inSect) {return 1;};
  virtual	void    SetPixelSpacing(float pixel);
  virtual float   GetPixelSpacing() { return mPixelSpacing; };
  virtual void    SetUpdateTimePerSect(float inVal) { mUpdateTimePerSect = inVal; };
  virtual int     AddTitle(const char *inTitle);
  virtual int     CheckMontage(MontParam *inParam) {return 0;}; 
  virtual int     getPcoord(int inSect, int &outX, int &outY, int &outZ, bool gotMutex = false) {return -1;};
  virtual int     getStageCoord(int inSect, double &outX, double &outY) {return -1;};
  virtual KImage  *getRect(void) {return NULL;};
  virtual int     ReorderPieceZCoords(int *sectOrder) { return -1; };
  virtual int     setMode(int inMode) {return 0;};
  virtual bool    fileIsShrMem() { return false; };

  int CheckMontage(MontParam *inParam, int nx, int ny, int nz);
  virtual void    setTime(int inTime);
	virtual void    setSection(int inSection);
	virtual CString getName(void) {return mFilename;};
  virtual void    MakeNameBeFullPath();
	virtual BOOL    FileOK() { return (mFile != NULL); };
  static int      lookupPixSize(int inMode);
	virtual void    SetTruncation(float inTruncLo, float inTruncHi)
			{ mFileOpt.pctTruncLo = inTruncLo; mFileOpt.pctTruncHi = inTruncHi; }
  virtual void    SetUnsignedOption(int inOpt) {mFileOpt.unsignOpt = inOpt;};
  virtual void    SetSignedOption(int inOpt) {mFileOpt.signToUnsignOpt = inOpt;};
  virtual void    SetCompression(int inComp) {mFileOpt.compression = inComp;};
  virtual int     GetCompression() {return mFileOpt.compression;};
	
	virtual float   getPixel(KCoord &inCoord);
  virtual float   getLastIntTruncation() {return mFracIntTrunc;};
  virtual void    setName(CString inName) {mFilename = inName;};
  virtual void    minMaxMean(char * idata, float & outMin, float & outMax, 
    double & outMean);
  virtual char    *convertForWriting(KImage *inImage, bool needFlipped, bool &needToReflip,
    bool &needToDelete);
  virtual void CommonInit(void);
  virtual bool montCoordsInAdoc() {return mAdocIndex >= 0 && mMontCoordsInMdoc;};
  virtual int FixInappropriateMontage();
  virtual CString getAdocName(void);
  virtual int getImageShift(int inSect, double &outISX, double &outISY);
  virtual unsigned int getChecksum();
  virtual int getUnsignOpt() {return mFileOpt.unsignOpt;};
  virtual int getSignToUnsignOpt() {return mFileOpt.signToUnsignOpt;};
  virtual int MarkAsOpenWithFile(const char *extension);
  virtual int InitializeAdocGlobalItems(bool needMutex, BOOL isMontage, const char *filename);
  virtual bool CheckNewSectionManageMMM(KImage *image, int inSect, char *idata, 
    int &nz, float &amin, float &amax, float &amean);
  virtual int AddExtraValuesToAdoc(KImage *inImage, int inSect, bool needNewSect, bool &gotMutex);
  virtual int AddTitleToAdoc(const char *inTitle);
  virtual int CheckAdocForMontage(MontParam *inParam);
  virtual int GetPCoordFromAdoc(const char *sectName, int inSect, int &outX, int &outY, int &outZ, bool gotMutex = false);
  virtual int GetStageCoordFromAdoc(const char *sectName, int inSect, double &outX, double &outY);
  virtual int ReorderZCoordsInAdoc(const char *sectName, int *sectOrder, int nz);
  virtual void AddTitleToLabelArray(char *label, int &numTitle, const char *inTitle);
  virtual int WriteHeader(bool adocAlso) { return 0; };
  virtual int GetWrittenByVersion() { return mWrittenByVersion; };
};


#endif