PIAACMCsimul.h

Go to the documentation of this file.

#ifndef _PIAACMCSIMUL_H
#define _PIAACMCSIMUL_H



#define ApoFitCosFact 1.0


#include <stdint.h>




//
// *****************************************************************************************************
// -------------------------- structure holding global variables ---------------------------------------
// *****************************************************************************************************

typedef struct {
    
    char piaacmcconfdir[300];          
    int optsystinit;
    
    int FORCE_CREATE_Cmodes;
    int CREATE_Cmodes;
    int FORCE_CREATE_Fmodes;
    int CREATE_Fmodes;

    int FORCE_CREATE_fpmzmap;
    int CREATE_fpmzmap;
    int FORCE_CREATE_fpmzt;
    int CREATE_fpmzt;

    int FORCE_CREATE_fpmza;
    int CREATE_fpmza;

    int FORCE_MAKE_PIAA0shape;
    int MAKE_PIAA0shape;
    int FORCE_MAKE_PIAA1shape;
    int MAKE_PIAA1shape;    
    
    int focmMode; // if != -1, compute only impulse response to corresponding zone
    int PIAACMC_FPMsectors;
    
    double FPMSCALEFACTOR;  

    double LAMBDASTART;
    double LAMBDAEND;
    
    float PIAACMC_MASKRADLD;
    
    // for minimization
    double *fpmresp_array;
    double *zonez_array;
    double *zonez0_array;
    double *zonez1_array;
    double *zonezbest_array;
    double *dphadz_array;
    double *outtmp_array;
    long LOOPCNT;
    
    long vsize;
    
    double CnormFactor; // for contrast normalization
    
    int computePSF_FAST_FPMresp;
    int computePSF_ResolvedTarget; // source size = 1e-{0.1*computePSF_ResolvedTarget}
    int computePSF_ResolvedTarget_mode; // 0: source is simulated as 3 points, 1: source is simulated as 6 points
    int PIAACMC_FPM_FASTDERIVATIVES;
    
    double SCORINGTOTAL;
    double MODampl;
    int SCORINGMASKTYPE;
    int PIAACMC_save;
//  float PIAACMC_MASKregcoeff;
    int PIAACMC_fpmtype; // 0 for idealized PIAACMC focal plane mask, 1 for physical focal plane mask
    
    long PIAACMC_FPMresp_mp;
    long PIAACMC_FPMresp_thread;
    
    int WRITE_OK;
    
    double PIAACMCSIMUL_VAL;
    double PIAACMCSIMUL_VAL0;
    double PIAACMCSIMUL_VALREF;


    // Linear Optimization
    int LINOPT;                         // 1 if linear optimization should be started
    long linopt_number_param;           // number of optimization paramters
    int linopt_paramtype[10000];        // _DATATYPE_FLOAT or _DATATYPE_DOUBLE
    float *linopt_paramvalf[10000];     // array of pointers, float
    double *linopt_paramval[10000];     // array of pointers, double
    double linopt_paramrefval[10000];
 
    double linopt_paramdelta[10000];
    double linopt_paramdeltaval[10000];
    double linopt_parammaxstep[10000];  // maximum single iteration step
    double linopt_parammin[10000];      // minimum value
    double linopt_parammax[10000];      // maximum value

    int linopt_REGPIAASHAPES;
    float linopt_piaa0C_regcoeff;
    float linopt_piaa1C_regcoeff;
    float linopt_piaa0C_regcoeff_alpha;
    float linopt_piaa1C_regcoeff_alpha;

    float linopt_piaa0F_regcoeff;
    float linopt_piaa1F_regcoeff;
    float linopt_piaa0F_regcoeff_alpha;
    float linopt_piaa1F_regcoeff_alpha;

    int linopt_REGFPMSAG;
    
    long linopt_NBiter;


    char fnamedescr[800]; // File name descriptor for focal plane mask, inserted inside output file names
    char fnamedescr_conf[800]; // File name descriptor for focal plane mask configuration, inserted inside output file names

    
} PIAACMCsimul_varType;







//
// *****************************************************************************************************
// -------------------------- structure defining a reflective PIAACMC system ---------------------------
// *****************************************************************************************************



//
// this structure holds parameters to be optimized in the PIAACMC diffractive design
//
typedef struct {

    // ======= SEED RADIAL PIAACMC PARAMETERS ======

    double centObs0;     
    double centObs1;     
    double r0lim;        
    double r1lim;        
    long NBradpts;       
    // Wavelength
    int nblambda;
    double lambda; // central wavelength [m]
    double lambdaB; // spectral bandwidth [%]
    double lambdaarray[2000]; // [m]  lambdaarray is also defined in OptSystProp structure


    // ====== Overall OPTICAL Geometry ===============

    float beamrad; // [m]
    long size;
    float pixscale; // [m/pix]

    int PIAAmode; // 0: no PIAA, 1: PIAA

    float PIAA0pos; // conjugation (z) of first PIAA surface [m]
    float PIAAsep;// separation between PIAA surfaces [m]
    int prePIAA0mask; // 1 if mask before PIAA surface 0
    float prePIAA0maskpos; // position of mask before PIAA surface 0 [m]
    int postPIAA0mask; // 1 if mask after PIAA surface 0
    float postPIAA0maskpos; // position of mask after PIAA surface 0 [m]
    float PIAAcoeff; // fraction of apodization done by PIAA
    int invPIAAmode; // 0: no inv PIAA, 1: inv PIAA after Lyot stops, 2: inv PIAA before Lyot stops
    float LyotZmin;
    float LyotZmax;
    float pupoutmaskrad; // output pupil mask radius (scaled to pupil radius)

    // ========== WAVEFRONT CONTROL ==================
    int nbDM; // number of deformable mirrors (10 max)
    double DMpos[10]; // DM conjugation in collimated space
    long ID_DM[10];  // DM image identifier


    // ========= LYOT STOPS ============
    long NBLyotStop;          
    long IDLyotStop[10];
    double LyotStop_zpos[10];

    // ======= Optics shapes modes ============
    char PIAAmaterial_name[10]; 
    int PIAAmaterial_code; 
    long CmodesID; // Cosine radial mode
    long Cmsize; // cosine modes size
    long NBCmodes;
    long piaaNBCmodesmax; // maximum number of radial cosine modes for PIAA optics

    long FmodesID; // Fourier 2D modes
    long Fmsize;
    long NBFmodes;
    float piaaCPAmax; // maximum spatial frequency (CPA) for PIAA optics

    long piaa0CmodesID;
    long piaa0FmodesID;
    long piaa1CmodesID;
    long piaa1FmodesID;

    // PSF flux calib
    float peakPSF;


    // ========= Focal Plane Mask ============

    double fpmaskradld; // mask radius [l/d] for the idealized PIAACMC starting point
    long focmNBzone; // number of zones
    double Fratio; // beam Fratio at focal plane
    long zonezID;  // focm zone material thickness, double precision image, named fpmzt / fpm_zonez.fits
    double fpmaskamptransm; // mask amplitude transmission (normally 1.0)
    long zoneaID;  // focm zone amplitude transmission, double precision image, named fpmza / fpm_zonea.fits
    double fpzfactor; // focal plane mask DFT zoom factor

    double fpmRad; // outer radius of physical focal plane mask [m]

    long NBrings; // number of rings
    double fpmminsag; // [m]
    double fpmmaxsag; // [m]
    double fpmsagreg_coeff;
    double fpmsagreg_alpha;
    long NBringCentCone; // number of rings that the central cone occupies
    double fpmCentConeRad; // [m]
    double fpmCentConeZ; // peak sag of central cone [m]
    double fpmOuterConeZ; // outer sag offset [m]
    double fpmOuterConeRadld; // outer radius (end of outer cone) [lambda/D] 
    double fpmOuterConeRad; // [m]
    long fpmarraysize;
    char fpmmaterial_name[10]; 
    int fpmmaterial_code; 
 
    // Mask description
    //
    // CENTRAL CONE
    // inner zone (optional) is a cone, covering the central NBringCentCone rings (set to zero for no central cone)
    // The outer edge of the central cone is at sag = 0, and the central peak of the cone is at sag fpmCentConeZ
    //
    // SECTORS
    // The next zone outwards consists of sectors arranged in rings. Each sector has its own sag
    // The zones are between sag fpmminsag and fpmmaxsag
    // 
    // OUTER CONE
    // The outer cone starts at the outer edge of the sectors, where it has sag=0
    // Its outer is at sag fpmOuterZ
    // outside of the outer cone, the sag is constant at fpmOuterZ
    //
 
 
} OPTPIAACMCDESIGN;






/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */

void __attribute__ ((constructor)) libinit_PIAACMCsimul();

int_fast8_t init_PIAACMCsimul();


static void PIAACMCsimul_logFunctionCall(char *LogFileName, const char *FunctionName, long line, char *comments);



void  PIAACMCsimul_free( void );


void PIAACMCsimul_init( OPTPIAACMCDESIGN *design, long index, double TTxld, double TTyld );


int PIAACMCsimul_initpiaacmcconf(long piaacmctype, double fpmradld, double centobs0, double centobs1, int WFCmode, int load);


int PIAACMCsimul_update_fnamedescr_conf();
int PIAACMCsimul_update_fnamedescr();

int PIAACMCsimul_savepiaacmcconf(const char *dname);

int PIAACMCsimul_loadpiaacmcconf(const char *dname);






/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */

long PIAACMCsimul_mkFPM_zonemap(const char *IDname);

long PIAACMCsimul_rings2sectors(const char *IDin_name, const char *sectfname, const char *IDout_name);

long PIAACMCsimul_mkFocalPlaneMask(const char *IDzonemap_name, const char *ID_name,  int mode, int saveMask);




/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */

uint_fast8_t PIAACMCsimul_load2DRadialApodization(const char *IDapo_name, float beamradpix, const char *IDapofit_name);

int PIAACMCsimul_init_geomPIAA_rad(const char *IDapofit_name);

int PIAACMCsimul_mkPIAAMshapes_from_RadSag(const char *fname, const char *ID_PIAAM0_name, const char *ID_PIAAM1_name);

int PIAACMCsimul_makePIAAshapes(OPTPIAACMCDESIGN *design, long index);




/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */

long PIAACMCsimul_mkSimpleLyotStop(const char *ID_name, float rin, float rout);

double PIAACMCsimul_optimizeLyotStop(const char *IDamp_name, const char *IDpha_name, const char *IDincoh_name, float zmin, float zmax, double throughput, long NBz, long NBmasks);

long PIAACMCsimul_mkLyotMask(const char *IDincoh_name, const char *IDmc_name, const char *IDzone_name, double throughput, const char *IDout_name);

long PIAACMCsimul_geomProp(const char *IDin_name, const char *IDsag_name, const char *IDout_name, const char *IDoutcnt_name, float drindex, float pscale, float zprop, float krad, float kstep, float rlim);



/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */

double PIAACMCsimul_achromFPMsol_eval(double *fpmresp_array, double *zonez_array, double *dphadz_array, double *outtmp_array, long vsize, long nbz, long nbl);

double PIAACMCsimul_achromFPMsol_eval_zonezderivative(long zone, double *fpmresp_array, double *zonez_array, double *dphadz_array, double *outtmp_array, long vsize, long nbz, long nbl);

long PIAACMC_FPMresp_rmzones(const char *FPMresp_in_name, const char *FPMresp_out_name, long NBzones);

long PIAACMC_FPMresp_resample(const char *FPMresp_in_name, const char *FPMresp_out_name, long NBlambda, long PTstep);



/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */


long PIAACMC_FPM_process(const char *FPMsag_name, const char *zonescoord_name, long NBexp, const char *outname);

long PIAACMC_FPMresp_resample(const char *FPMresp_in_name, const char *FPMresp_out_name, long NBlambda, long PTstep);




/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */
/* =============================================================================================== */

int PIAACMCsimul_exec(const char *confindex, long mode);

double PIAACMCsimul_computePSF(float xld, float yld, long startelem, long endelem, int savepsf, int sourcesize, int extmode, int outsave);

long PIAACMCsimul_CA2propCubeInt(const char *IDamp_name, const char *IDpha_name, float zmin, float zmax, long NBz, const char *IDout_name);

int PIAACMCsimul_run(const char *confindex, long mode);


int PIAACMCsimul_exec_compute_image();
int PIAACMCsimul_exec_optimize_lyot_stop_position();
int PIAACMCsimul_exec_optimize_fpmtransmission();
double PIAACMCsimul_exec_computePSF_no_fpm();
int PIAACMCsimul_exec_optimize_PIAA_shapes();
int PIAACMCsimul_exec_optimize_lyot_stops_shapes_positions();
int PIAACMCsimul_exec_multizone_fpm_calib();
int PIAACMCsimul_exec_optimize_fpm_zones();
int PIAACMCsimul_exec_optimize_PIAA_shapes_fpmtransm();

int PIAACMCsimul_measure_transm_curve();
int PIAACMCsimul_eval_poly_design();





#endif