; MAP_PROJ_INIT
; Documentation in progress
; equivalent to the original procedure, except that instead of 40 or
; so projections here we give access to all the PROJ projections (120+)
; Note: the structure of the resulting mapstruct is not compatible with
; IDL, i.e., one cannot use a GDL-defined mapstruct in IDL (if passed
; within a save file), (but one can use an IDL-defined mapstruct in GDL).
; March 2021: changed 'proj4...' to 'proj...' everywhere in GDL, except here where the structure tag is still 'proj4name'
;rotates vector p1 around vector a by angle theta (degrees) 
function map_rotate3d, p1, a, theta
    compile_opt idl2, hidden
    ON_ERROR, 2  ; return to caller
    deg2rad=!dpi/180d
    st=sin(theta*deg2rad)
    ct=cos(theta*deg2rad)
    ; quaternion-derived rotation matrix
    matrix=[[ a[0] * a[0] * (1 - ct) + ct, a[0] * a[1] * (1 - ct) - a[2]*st, a[0] * a[2] * (1 - ct) + a[1] * st],$
      [ a[1] * a[0] * (1 - ct) + a[2]*st, a[1] * a[1] * (1 - ct) + ct, a[1] * a[2] * (1 - ct) - a[0] * st],$
      [ a[2] * a[0] * (1 - ct) - a[1]*st, a[2] * a[1] * (1 - ct) + a[0]*st, a[2] * a[2] * (1 - ct) + ct ]]
    ; multiply matrix vector
    vector=[p1[0], p1[1], p1[2]]
    rotated = matrix # vector
    return, rotated
 end

pro map_proj_set_split, myMap
    compile_opt idl2, hidden
    ON_ERROR, 2  ; return to caller
    ; v0 and u0 are the center lon & lat
    sinlat = sin(myMap.v0)
    coslat = cos(myMap.v0)
    sinlon = sin(myMap.u0)
    coslon = cos(myMap.u0)
    xyzProjCenter = [coslon*coslat, sinlon*coslat, sinlat]
; pole:lon & lat in rad, sin and cos of polar latitude, x,y,z
; coordinates of pole.
; SPLIT General case: if projection center is at (lon,lat) of 3D coords x,y,z and pole at xp,yp,zp
; we have SPLIT=[lon, lat, CROSSP([x, y, z], [xp, yp, zp]), 0]
    pole = myMap.pole[4:6]        ;Location of pole
    plane = CROSSP(xyzProjCenter, pole)
    split=[myMap.p0lon, myMap.p0lat, plane, 0d]
    MAP_CLIP_SET, MAP=myMap, SPLIT=split
end

; Ancillary procedure, compute limits (uv_box and ll_box) for full maps. Used only in initialization phase
; of the projDefinitions.sav file
pro gdl_compute_map_limits, myMap
  
  compile_opt idl2, hidden
  
  xmin=-1d & ymin=-1d & xmax=1d & ymax=1d
  
  lonmin=-180.0d & lonmax=180.0d & latmin=-90.0d & latmax=90.0d
  lonrange = lonmax - lonmin
  latrange = latmax - latmin
; is there another way (PROJ) to get ranges except brute force on a grid of possible points?
; epsilon useful as projections are not precise (see #define EPS in PROJ c files: apparently < 1e-6)
  epsx = 1d-6*ABS(lonrange)
  epsy = 1d-6*ABS(latrange)

  n_lons = 720
  lons = [ lonmin + epsx, DINDGEN(n_lons)*(lonrange/(n_lons-1d)) + lonmin, lonmax - epsx] & n_lons += 2
     
  n_lats = 360
  lats =  [latmin + epsy, DINDGEN(n_lats)*(latrange/(n_lats-1d)) + latmin, latmax - epsy, -epsy, epsy] & n_lats += 4 
     
  lons = reform(rebin(lons, n_lons, n_lats), 1, n_lons*n_lats)
  lats = reform(rebin(transpose(lats), n_lons, n_lats), 1, n_lons*n_lats)
  tmp = [temporary(lons), temporary(lats)]
     
  xy = map_proj_forward(tmp, MAP=myMap)
                                ; Default if no points are valid is just the map_limits.
  good = WHERE(FINITE(xy[0,*]) and FINITE(xy[1,*]), ngood)

  if (ngood gt 0) then begin
    xy = xy[*, good]
    lonlat = tmp[*, good]
                                ; further check: are backprojected good points really close to original point?
    tmp = MAP_PROJ_INVERSE(xy, MAP=myMap)
    bad = WHERE(~FINITE(tmp[0,*]) or ~FINITE(tmp[1,*]), nbad)
    if (nbad gt 0) then tmp[*, bad] = -9999
    diff = ABS(lonlat - tmp)
    diff[0,*] = diff[0,*] mod 360 ; Ignore 360 degre differences for longitude.
    w = where(diff[0,*] gt 359.99, count) & if count gt 0 then diff[0,w] = 0
    w = where((abs(tmp[0,*]) le 720) and (abs(tmp[1,*]) le 90) and (total(diff,1) lt 1d), count)
    if (count gt 0) then begin ; Only those good during forward and inverse projection.
      lonlat = lonlat[*, w]
      xy = xy[*,w]
    endif
    xmin = min(xy[0,*], max=xmax)
    ymin = min(xy[1,*], max=ymax)
    lonmin = min(lonlat[0,*],poslonmin, max=lonmax, subscript_max=poslonmax)
    latmin = min(lonlat[1,*],poslatmin, max=latmax, subscript_max=poslatmax)
  endif
  
  myMap.ll_box = [latmin, lonmin, latmax, lonmax]
  myMap.uv_box = [xmin, ymin, xmax, ymax]
end


function map_proj_init, pindex, p4number=p4number, relaxed=relaxed, rotation=rotation, gctp=gctp, radians=radians, limit=passed_limit, ellipsoid=ellipsoid, semimajor_axis=semimajor_axis, semiminor_axis=semiminor_axis, sphere_radius=sphere_radius, center_azimuth=center_azimuth, datum=datum, clip=clip,  gdl_precise=gdl_precise, check_proj4=chkprj4,  _extra=extra
    compile_opt idl2, hidden
    ON_ERROR, 2  ; return to caller

; NOTE: We are always "relaxed".
; p4num bool indicates pindex is a number and refers to the internal PROJ table of PROJ properties line and not an IDL number for which an equivalent must be found 

; define limit
if n_elements(passed_limit) lt 4 then limit=dblarr(4) else limit=double(passed_limit)

; the common contains all relevant values after initialisation
@gdlcommon_mapprojections_common
deg2rad=!dpi/180d

nkeys=n_tags(required)

required_kw4=" +"+strlowcase(tag_names(required))+"="

nproj=n_elements(proj)

sindex=pindex
; find projection index, by index:
if (N_ELEMENTS(pindex) le 0) then begin 
   index=where(proj.proj4name eq 'stere') ; stereo is default
; this is a drawback: projection number is always an IDL number 
endif else if (SIZE(pindex, /TYPE) ne 7) then begin
   if keyword_set(p4number) then sindex=proj[pindex].fullname else sindex=idl_ids[pindex]
endif
; now by name, as pindex is a string

; grep best candidate name
shortname = strupcase(strcompress(sindex, /REMOVE_ALL))
                                ;defaults to IDL projection_names, check:
w = strcmp(idl_ids,shortname,strlen(shortname)) & count=total(w)
if count gt 1 then message, /noname, 'Ambiguous Projection abbreviation: ' + sindex
if count eq 1 then begin
   name4=idl_equiv[(where(w eq 1))[0]]
   index=where(proj.proj4name eq name4, count) & if count eq 0 then message, 'Projection ' + sindex + ' apparently does not exist in Proj4 library, fixme.' 
endif else begin
   ; next, PROJ projections
   w = strcmp(compressed_ids1,shortname,strlen(shortname)) & count=total(w)
   if count eq 0 then begin w = strcmp(compressed_ids2,shortname,strlen(shortname)) & count=total(w) & end ; alternative
   if count eq 0 then message, /noname, 'Invalid Projection name: ' + sindex
   if count eq 1 then index=where(w eq 1) else begin ; gt 1: ambiguous
      message, /noname,/informational,'Ambiguous Projection name: ' + sindex
      pos=where(w eq 1)
      choices=compressed_ids1[pos]
      lengths=strlen(choices)
      match=min(lengths,j)
      adopted=choices[j]
      w = strcmp(compressed_ids1,adopted,strlen(compressed_ids1))
      pos=where(w eq 1)
      index=pos[0]
   endelse
endelse

; no more than nproj-1
if index ge nproj then message, /noname,   'Invalid Projection number: ' + strtrim(sindex)

; useful strings:
; get base projection name!
p4n=proj[index].proj4name
; need to keep ony the real projection (PROJ) name if perchance there was additional commands already set in the name
p4n=(strsplit(strtrim(p4n,2),' ',/extract))[0] 

; required parameters, filled.
filled_required_parameter_string=""
list_of_needed_params=""
; optional parameters as passed
filled_optional_parameter_string=""

; create list of REQUIRED parameters
required_opt=""
for i=0,nkeys-1 do if required[index].(i) then required_opt+=required_kw4[i]
if strlen(required_opt) gt 0 then begin
   list_of_needed_params=strsplit(required_opt,' ',/extract)
   n_required=n_elements(list_of_needed_params)
endif else n_required=0

; all optional elements in a string; add false northing easting that are
; common for all projections.
optional_opt=optional[index]+" x_0= y_0="
list_of_optional_params="+"+strsplit(optional_opt," ",/extract) 
n_optional = n_elements(list_of_optional_params)
;print,list_of_optional_params

;define type(s) of current projection 
property=proj_properties[index]
if (property.EXIST eq 0) then message,'Unfortunately, projection '+shortname+ ' is flagged as absent. Please check MAP_INSTALL in GDL documentation.'
conic=(property.CONIC eq 1)
elliptic=(property.ELL eq 1)
spheric=(property.SPH eq 1)
cylindric=(property.CYL eq 1)
azimuthal=(property.AZI eq 1)
interrupted=(property.INTER eq 1)
noRot=(property.NOROT eq 1) ; this indicates that, unexpectedly, a GOR cannot be tempted on this particular projection.
; enable non-zero latitudes by use of general oblique rotation (GOR).
; this is general but GOR adds uncertainties (and complexity=execution
; time, especially near the poles). Besides, some projections crash
; GDL when GOR is tempted. Finally, some projections do not need GOR
; (they accept and use +lat_0=). Interrupted must not use GOR of course.
; it can be forbidden by definition of NOROT
rotPossible= ( ~noROT and ~azimuthal and ~conic and ~interrupted )

; GOR should not be tempted on projections that use +alpha and/or +lonc, as these
; should be passed as arguments.
if (n_required gt 0 or n_optional gt 0) then begin
   w=WHERE(STRMATCH([list_of_needed_params,list_of_optional_params], '+alpha=') EQ 1, count)
   if (count gt 0) then rotPossible=0
endif

south=0

passed_params=""

n_passed=0
list_of_passed_params=!NULL
; enable abbreviated parameters
if n_elements(extra) gt 0 then begin
   
   passed_params = TAG_NAMES(extra)
   
   ; instead of comparing passed_params directly to hash key, check possible abbreviations:
   possible_params=tag_names(dictionary.tostruct())
   for i=0,n_tags(extra)-1 do begin
      w = strcmp(possible_params,passed_params[i],strlen(passed_params[i])) & count=total(w) & j=(where(w eq 1))[0]
      if count eq 1 then begin
         passed_params[i]=possible_params[j] ; make passed_params normalized.
         projkw=dictionary[possible_params[j]]
         list_of_passed_params= (n_elements(list_of_passed_params) eq 0)? projkw : [list_of_passed_params,projkw]
         passed_values= (n_elements(passed_values) eq 0)? strtrim(extra.(i),2) : [passed_values,strtrim(extra.(i),2)]
      endif else if count gt 1 then message,"Ambiguous keyword abbreviation: "+passed_params[i]
   endfor
   n_passed=n_elements(list_of_passed_params) ; the only useful, recognized, ones, along with their passed_values.
endif

if n_passed gt 0 and n_passed ge n_required then begin
; do we have required values for projection?
   if n_required gt 0 then begin
; needed params: get individual PROJ keywords, find if equivalent is
; existing in passed_params. Based on equivalence list above.

; sort in alphabetic order
      s_needed=sort(list_of_needed_params)
      ;create index table
      tindex=(intarr(n_passed))-1; //-1 to further check
      ; find all matches
      for i=0,n_required-1 do begin
         w=where(list_of_passed_params eq list_of_needed_params[i], count) & if count gt 0 then  tindex[i]=w[0] ; we do not check duplicated entries, we take first.
      endfor
      ; tindex positive values need equal n_required here if all match were made
      w=where(tindex ge 0, count, comp=absent) & if count ne n_required then begin
         kwlist=""
         ; reverse match: now we want needed_params that are not in passed_params.
         for i=0,n_required-1 do begin
            w=where(list_of_needed_params[i] eq list_of_passed_params, count) & if count eq 0 then kwlist+=yranoitcid[list_of_needed_params[i]]+" "
         endfor
         message,"Missing required parameters: "+kwlist
      endif
      ; populate required parameter list
      for i=0,n_required-1 do begin
         ; filter negative values for zone and set south
         if list_of_needed_params[i] eq "+zone=" then begin
            the_zone=fix(passed_values[tindex[i]])
            if the_zone lt 0 then begin
               passed_values[tindex[i]]=strtrim(-1*the_zone,2)
               south=1
            endif
         endif
         filled_required_parameter_string+=" "+list_of_needed_params[i]+passed_values[tindex[i]]
      endfor
   endif

   ; do we have optional values for projection?
   if n_optional gt 0 then begin
      ; sort in alphabetic order
                                ;create index table
      tindex=(intarr(n_optional))-1 ; //-1 to further check
                                ; find all matches
      for i=0,n_optional-1 do begin
         w=where(list_of_passed_params eq list_of_optional_params[i], count) & if count gt 0 then tindex[i]=w[0] 
      endfor
                                ; w is the short list of optional passed values
      w=where(tindex ge 0, count) & if count gt 0 then begin
                                ; populate optional parameter list
         tindex=tindex[w]
         for i=0,count-1 do begin
            ; filter +n value between 0 and 1 only for fouc_s:
            if list_of_passed_params[tindex[i]] eq "+n=" and p4n eq "fouc_s" then begin
               n_val=fix(passed_values[tindex[i]])
               if (n_val lt 0 or n_val gt 1) then message,"Invalid parameter value ("+strtrim(n_val,2)+") for Foucaut Sinusoidal"
            endif
            filled_optional_parameter_string+=" "+list_of_passed_params[tindex[i]]+passed_values[tindex[i]] ; strtrim(extra.(tindex[i]),2)
         endfor
      endif
   endif
endif else begin                ; or not...
   if strlen(required_opt) gt 0 then  message, "Absent (PROJ) parameter(s): "+required_opt
endelse

; main string (will need special treatment for rotation etc.)
projcommand="+proj="+proj[index].proj4name+" "

projoptions=filled_required_parameter_string+filled_optional_parameter_string

; ok, projoptions contains all relevant AND permitted parameters. Try to assemble
; all these into valid elements of !map. Up to now we have only
; translated from idl to PROJ. now is time to interpret things a bit.

; define useful defaults values
p0lon = 0d                      ; center longitude
p0lat = 0d                      ; center latitude
 if n_elements(rotation) le 0 then rotation=0d ; rotation
p1=0 ; locally used standard parallels p1 and p2
p2=0
satheight=0
alpha=90 ; 
lonc=0 ; see f.e. oblique mercator in proj.org 

if strlen(projoptions) gt 0 then begin
; convert projoptions to hash
   s=strsplit(strtrim(projoptions,2),"= ",/extract)
   x=where(strpos(s,'+') eq 0, comp=y)
   a=hash(s[x],s[y])
; if a contains "+lon_0" this is p0lon, etc.
   if a.HasKey("+lon_0") then p0lon=(a["+lon_0"]*1d)[0]
   if a.HasKey("+lat_0") and rotPossible then begin
      p0lat=(a["+lat_0"]*1d)[0]
   endif
   if a.HasKey("+lat_1") then p1=(a["+lat_1"]*1d)[0]
   if a.HasKey("+lat_2") then p2=(a["+lat_2"]*1d)[0]
   if a.HasKey("+h")     then satheight=a["+h"]*1d
   if a.HasKey("+alpha") then alpha=a["+alpha"]*1d
   if a.HasKey("+lonc")  then lonc=a["+lonc"]*1d
endif


; adjust ranges
map_adjlon,p0lon
p0lat= p0lat > (-89.999) & p0lat=p0lat < 89.999
p1=p1 > (-89.999) & p1=p1<89.999
p2=p2 > (-89.999) & p2=p2<89.999
;if (p2 lt p1) then begin & tmp=p2 & p2=p1 & p1=p2 & end

if (rotPossible) then begin
  search_string='+lat_0='
; try a general oblique transformation
   if n_passed ne 0 then begin
      w=where(list_of_passed_params eq search_string, count)
      if count gt 0 then begin  ; try general oblique
         p0lat=extra.(w[0])
         if p0lat ne 0 then begin 
            if p0lat gt 89.9 then p0lat = 89.9 ;take some precautions as PROJ is not protected!!! 
            if p0lat lt -89.9 then p0lat = -89.9 ;
            ; compute pole of transformed projection
            projcommand="+proj=ob_tran +o_proj="+proj[index].proj4name
            ; remove '+lat_0=xxx +lon_0=xxx' from projoptions
            a=strsplit(projoptions,"\+lat_0=[0-9.]*",/regex,/extract)
            a=strsplit(projoptions,"\+lon_0=[0-9.]*",/regex,/extract)
            projoptions=strjoin(a)
         endif else rotPossible=0B
      endif
   endif else rotPossible=0B
endif

; for conic projections, although lat_0 is not in the list of
; authorized parameters, it works, so we add it, as it is very
; important to center the projection.
if noRot eq 1 then p0lat=0 else begin
   if (~rotPossible and (conic or spheric)) then begin ;
      w=where(list_of_passed_params eq '+lat_0=', count)
      if count gt 0 then begin
         val=passed_values[w[0]]
         p0lat=double(val)
         projoptions+=" +lat_0="+val
      endif
   endif
endelse

; create a 999 !map
myMap={!map}
myMap.projection=999
mymap.p[15]=index ;!useful for map_proj_info and unused apparently.
myMap.p0lon = p0lon
myMap.p0lat = p0lat
myMap.u0 = p0lon * deg2rad
myMap.v0 = p0lat * deg2rad
;myMap.a = semimajor     ; ellipsoid --> need table of correspondences!
;myMap.e2 = e2

myMap.rotation = rotation                      ; map rotation
myMap.cosr=cos(rotation*deg2rad)
myMap.sinr=sin(rotation*deg2rad)
; pole is at +90 on meridian p0lon, eventually rotated by
; center_azimuth
pole_lon=p0lon
pole_lat=p0lat+90
; pole sines and xyz
psinlat = 1d
pcoslat = 0d
psinlon = 0d
pcoslon = 1d
xyzpole = [pcoslon*pcoslat, psinlon*pcoslat, psinlat]
; projection center sines and xyz
csinlat = sin(myMap.v0)
ccoslat = cos(myMap.v0)
csinlon = sin(myMap.u0)
ccoslon = cos(myMap.u0)
xyzProjCenter = [ccoslon*ccoslat, csinlon*ccoslat, csinlat]

if pole_lat gt 90 then begin
  pole_lon+=180 & if pole_lon gt 180 then pole_lon-=360.0
  pole_lat=180-pole_lat
  psinlat = sin(pole_lat*deg2rad)
  pcoslat = cos(pole_lat*deg2rad)
  psinlon = sin(pole_lon*deg2rad)
  pcoslon = cos(pole_lon*deg2rad)
  xyzpole = [pcoslon*pcoslat, psinlon*pcoslat, psinlat]
endif
; rotate pole by center_azimuth if needed
if keyword_set(center_azimuth) and rotPossible then begin
  xyz=map_rotate3d(xyzpole,xyzprojcenter,center_azimuth)
  pole_lon = atan(xyz[1], xyz[0])*!const.rtod
  pole_lat = atan(xyz[2], sqrt(xyz[0]^2 + xyz[1]^2))*!const.rtod
  xyzpole=xyz
  psinlat = sin(pole_lat*deg2rad)
  pcoslat = cos(pole_lat*deg2rad)
endif

; pole:lon & lat in rad, sin and cos of polar latitude, x,y,z
myMap.pole=[pole_lon*deg2rad,pole_lat*deg2rad,psinlat,pcoslat,xyzpole] ; need to define myMap.pole BEFORE calling MAP_PROJ_SET_SPLIT 

; now that pole is computed correctly, add pole position to
; generalized oblique
if rotPossible then begin
   projcommand+=" +o_alpha=90 +o_lat_c="+strtrim(p0lat,2)+" +o_lon_c=180"
   if (p0lat gt 0) then projcommand+=" +lon_0="+strtrim(p0lon,2) else  projcommand+=" +lon_0="+strtrim(180+p0lon,2)
endif


MAP_CLIP_SET, MAP=myMap, /RESET        ;Clear clipping pipeline.

; 1) get !map useful values
; radius or ell or..
myMap.a=6370997.0d ; default
myMap.e2=1
hasRadius=0 
ellipticalusagerequired=(p4n eq "utm" or p4n eq "ups")
if n_elements(sphere_radius) gt 0 then begin 
   hasRadius=1
   myMap.a=sphere_radius[0]
endif else begin 
   radius=6370997.0d ; myMap.a already ok
endelse

hasEll=0 

if n_elements(ellipsoid) gt 0 or n_elements(datum) gt 0 then begin ; case where myMap.a will be false!
   hasEll=1
   if n_elements(datum) gt 0 and n_elements(ellipsoid) eq 0 then ellipsoid=datum ; in case both are present.
   if ~(SIZE(ellipsoid, /TYPE) eq 7) then begin ; must give name (index in list)
      if ellipsoid gt 25 or ellipsoid lt 0 then message,"Invalid value for keyword ELLIPSOID: "+strtrim(ellipsoid,2)
      ellipsoid=ellipsoid_proj[ellipsoid] 
   endif else begin
      w = strcmp(strupcase(ellipsoid_idl),strupcase(ellipsoid),strlen(ellipsoid)) & count=total(w)
      if count gt 0 then begin
         pos=where(w gt 0) & ellipsoid=ellipsoid_proj[pos[0]]
      endif
   endelse
endif 

; defining +a and +b overrides R and Ell
hasDefinedEll=0
if n_elements(SEMIMAJOR_AXIS) gt 0 then begin
 hasRadius=0
 hasEll=0
 if ~n_elements(SEMIMINOR_AXIS) gt 0 then Message,"Keywords SEMIMAJOR_AXIS and SEMIMINOR_AXIS must both be supplied."
 hasDefinedEll=1
 myMap.a=SEMIMAJOR_AXIS
 f=1.-(semiminor_axis/semimajor_axis)
 myMap.e2 = 2*f-f^2
endif

; 2) split, clip..
; treat all interrupted cases separately (probably need to change !Map
; pipeline size to accomodate for many-faceted projections: not done
; but easy!
; non-azimuthal projections: split at 180 degrees from map center,
; then:
; conic: will cut out pole region at some lat, and stop somewhere on
; the other side, usually not far from the lat_2 if exists.
; cylindric: should cut 'cylinder ends' ---> not done properly for
; transverse?
; azim: should cut somewhere: gnomonic cannot show one hemisphere,
; other can, but will be very distorted.

if (interrupted or p4n eq 'bipc' or p4n eq "bertin1953" or p4n eq "qsc" ) then begin
  case p4n of
    "bertin1953": BEGIN
          theta = deg2rad * 16.5
          MAP_CLIP_SET, map=myMap, SPLIT=[16.5, 42, -sin(theta), $
                        cos(theta), 0., 0.]
          myMap.p0lon=16.5
          myMap.p0lat=42
    END
    "qsc": BEGIN
      MAP_CLIP_SET, MAP=myMap, CLIP_PLANE=[xyzProjCenter, -0.5]
    END
         "bipc": BEGIN
       splits = [-20,-110] + p0lon

       for i=0,n_elements(splits)-1 do begin 
          theta = deg2rad * splits[i]
          MAP_CLIP_SET, map=myMap, SPLIT=[splits[i], 0, -sin(theta), cos(theta), 0., 0.]
       endfor 
       myMap.up_flags=1000 ; redefine "epsilon" due to precision problems in PROJ!!!!

         END

    "igh": BEGIN
       splits =  [-180, -40, -100, -20, 80] + p0lon + 180.0d

       for i=0,n_elements(splits)-1 do begin 
          theta = deg2rad * splits[i]
          MAP_CLIP_SET, map=myMap, SPLIT=[splits[i], 0, -sin(theta), cos(theta), 0., 0.]
       endfor 
       myMap.up_flags=1000000 ; redefine "epsilon" due to precision problems in pr

     END

    "rhealpix": BEGIN
       splits = [-3*45, -2*45, -45, 0, 45, 2*45, 3*45] + 180d + p0lon

       for i=0,n_elements(splits)-1 do begin 
          theta = deg2rad * splits[i]
          MAP_CLIP_SET, map=myMap, SPLIT=[splits[i], 0, -sin(theta), cos(theta), 0., 0.]
       endfor 
       map_clip_set, map=myMap, SPLIT=[0,90,0,0,1d,-2d/3d]
       map_clip_set, map=myMap, SPLIT=[0,-90,0,0,-1d,-2d/3d]
       myMap.up_flags=10000 ; redefine "epsilon" due to precision problems in PROJ!!!!
    END

    "healpix": BEGIN
       splits = [-3*45, -2*45, -45, 0, 45, 2*45, 3*45] + 180d + p0lon

       for i=0,n_elements(splits)-1 do begin 
          theta = deg2rad * splits[i]
          MAP_CLIP_SET, map=myMap, SPLIT=[splits[i], 0, -sin(theta), cos(theta), 0., 0.]
       endfor 
       myMap.up_flags=10000 ; redefine "epsilon" due to precision problems in PROJ!!!!
    END
 ELSE: print,"Interrupted projection "+p4n+" is not yet properly taken into account in map_proj_init, please FIXME!"
 endcase
endif else begin ; not interrupted
   if not azimuthal then begin
      MAP_PROJ_SET_SPLIT,myMap ; standard cut
; conics: clip around the poles
      if conic then begin
                                ; apparently clipping is done 10 degrees above or below equator for
                                ; opposite hemisphere and at +75 degrees on same hemisphere unless the
                                ; standard parallels are not on the same side of equator, giving a 75
                                ; degree clip on both sides. 
         test1= (p1 ge 0.0) ? 1 : -1
         test2= (p2 ge 0.0) ? 1 : -1
         if (test1 eq test2) then begin
            map_clip_set, map=myMap, clip_plane=[0,0,test1,sin(deg2rad*10.)]
            map_clip_set, map=myMap, clip_plane=[0,0,-1*test2,sin(deg2rad*75.0)]
            myMap.p[13]=-1*test1*10. ; use it to store this value, see map_grid, map_horizon
            myMap.p[14]=test2*75.    ; use it to store this value, see map_grid, map_horizon
         endif else begin
            map_clip_set, map=myMap, clip_plane=[0,0,1,sin(deg2rad*75.0)]
            map_clip_set, map=myMap, clip_plane=[0,0,-1,sin(deg2rad*75.0)]
            myMap.p[13]=75.     ; use it to store this value, see map_grid, map_horizon
            myMap.p[14]=-75.    ; use it to store this value, see map_grid, map_horizon
         endelse
      endif else if cylindric then begin ; mercator et: clip 10 degrees from poles.
                                ;alpha is the rotation angle for
                                ;oblique cylindric. alpha=0 for
                                ;transverse projections
         val=80
         ; remove poles
         map_clip_set, map=myMap, clip_plane=[myMap.pole[4:6],sin(deg2rad*val)]
         map_clip_set, map=myMap, clip_plane=[-1*myMap.pole[4:6],sin(deg2rad*val)]
         myMap.p[13]=val        ; use it to store this value, see map_grid, map_horizon
         myMap.p[14]=-val       ; use it to store this value, see map_grid, map_horizon
      endif
   endif else begin               ; azim projs.
      val=-1d-8
      case p4n of
         "tpers": if satheight eq 0 then val=-0.5d else val=-1.01d /(1+satheight/myMap.a)
         "nsper": if satheight eq 0 then  val=-0.5d else val=-1.01d /(1+satheight/myMap.a)
         "gnom": val=-0.5d
      else: val=-0.49999d
      endcase
      MAP_CLIP_SET, MAP=myMap, CLIP_PLANE=[xyzProjCenter, val]
      myMap.p[14]=val         ; use it to store this value, see map_grid, map_horizon
   endelse                      ; end azim projs
endelse                         ; not interrupted

if ellipticalusagerequired then projOptions+=' +ellps=GRS80 '
if south then projOptions+=' +south'
; finalize projection to be used in finding limits:
myMap.up_name=projcommand+" "+projOptions

if (hasDefinedEll) then begin
myMap.up_name+=" +a="+strtrim(SEMIMAJOR_AXIS[0],2)+" +b="+strtrim(SEMIMINOR_AXIS[0],2)
endif else if (hasRadius and ~ellipticalusagerequired) then begin
myMap.up_name+=" +R="+strtrim(SPHERE_RADIUS[0],2)
endif else if (hasEll) then begin
myMap.up_name+=" +ell="+ellipsoid
endif

if keyword_set(chkprj4) then print,myMap.up_name
; 3) Set LIMITs and clip.

if keyword_set(gdl_precise) then gdl_compute_map_limits, myMap else gdl_set_map_limits, myMap, limit

; 4) transform
MAP_CLIP_SET, MAP=myMap, /transform        ;apply transform

; 5) clip uv
if ( keyword_set(clip) and n_elements(passed_limit) gt 0 ) then begin
 MAP_CLIP_SET, MAP=myMap, CLIP_UV = myMap.uv_box
endif

return,myMap
end

; in case one wants to add new projections to the ../resource/maps/projections.csv file.
pro map_proj_auxiliary_read_csv
    compile_opt idl2

    ON_ERROR, 2  ; return to caller
 restore,"csv.sav"
 nproj=n_elements(csv_proj.field1)
 names={PROJ4NAME:"",FULLNAME:"",OTHERNAME:""}
 proj_property={EXIST:1B,SPH:0B,CONIC:0B,AZI:0B,ELL:0B,CYL:0B,MISC:0B,NOINV:0B,NOROT:0B,INTER:0b} ; note uppercase
; fill the sorted, uniq, list of REQUIRED values
 t=strtrim(csv_proj.field5,2) & s=strjoin(t) & t=strsplit(s,"= ",/extract) 
 q=t[sort(t)] & required_template_list=q[uniq(q)]
 for i=0,n_elements(required_template_list)-1 do map_struct_append, required_template, required_template_list[i], 0b

 proj=replicate(names,nproj)
 proj.PROJ4NAME=csv_proj.FIELD1
 proj.FULLNAME=csv_proj.FIELD2
 proj.OTHERNAME=csv_proj.FIELD3

 proj_properties=replicate(proj_property,nproj)
 csv_proj.field4=strupcase(strcompress(csv_proj.field4,/remove_all)) ; note uppercase
 ntags=n_tags(proj_property)
 tname=strupcase(tag_names(proj_property))
 for i=0,ntags-1 do proj_properties[ WHERE(STRMATCH(csv_proj.field4, '*'+tname[i]+'*') EQ 1)].(i)=1

 required=replicate(required_template,nproj)
 ntags=n_tags(required_template)
 tname=strlowcase(tag_names(required_template)) ; ALL LOWCASE in table FOR THE MOMENT. WARNING if NOT!!!
 ; to avoid problems, each element of csv_proj.field5, which is a
 ; serie of strings like "plat_0= plon_0= phdg_0=" must be comparable
 ; only with same tname (ex: plat_0) and not a subset tname such as
 ; "lat_0". this implies to add at least one whitespace at the
 ; beginning:
 newfield5=" "+csv_proj.field5
for i=0,ntags-1 do begin & w=WHERE(STRMATCH(newfield5, '* '+tname[i]+'=*', /FOLD_CASE) EQ 1, count) & if (count gt 0) then required[w].(i)=1 & end

; optional
 optional=csv_proj.field6
; 
proj_limits=reform(replicate(-1.0d,4*nproj),4,nproj)
proj_scale=dblarr(nproj)

; save once to have map_proj_init work.
save,filen="projDefinitions.sav",proj,proj_properties,required,optional,proj_scale,proj_limits

; now compute default limits [-180..180, -90..90] for all projections.
; the idea is to call all the projections with all 'possible'
; parameters in order to have only unexisting projections that cause a
; (trapped) error. As the projection has been set up, the uv box is
; the one computed in map_proj_init using a brute force
; method. Obvioulsy this could be made more exact if the uv_box was
; part of the database, but imho this small amount of work will rebuke
; everybody. An other option would be to use Proj functions to get all
; the needed information, I've not looked into that.  
; call proj_init for uv_box approximate calculation...
for i=0,nproj-1 do begin
   catch,absent
   if absent ne 0 then begin
      print,'i was',i,' projection was ',proj[i].PROJ4NAME
      proj_properties[i].exist=0b
      continue
   endif
   myMap=map_proj_init(/gdl_precise, i,/p4num,alpha=0.0001,height=1,standard_parall=30,standard_par1=50,standard_par2=-45,sat_tilt=45,true_scale_latitude=12,lat_3=13,HOM_LONGITUDE1=1,HOM_LONGITUDE2=80,LON_3=120,OEA_SHAPEN=1, OEA_SHAPEM=1,SOM_LANDSAT_NUMBER=2, SOM_LANDSAT_PATH=22, ZONE=28) ; uses ellps=wgs84 by default.
      proj_scale[i]=abs(myMap.uv_box[2]-myMap.uv_box[0]) ; number of ellipsoid meters in uv_box
endfor
; proj_scale, only on existing projections.
for i=0,nproj-1 do begin
   catch,absent
   if absent ne 0 then begin
      print,'(known?) problem with projection '+proj[i].PROJ4NAME
      continue
   endif

   if proj_properties[i].exist eq 1 then begin 
      myMap=map_proj_init(/gdl_precise,i,/p4num,alpha=0.0001,sphere=1,height=1,standard_parall=30,standard_par1=50,standard_par2=-45,sat_tilt=45,true_scale_latitude=12,lat_3=13,HOM_LONGITUDE1=1,HOM_LONGITUDE2=80,LON_3=120,OEA_SHAPEN=1, OEA_SHAPEM=1,SOM_LANDSAT_NUMBER=2, SOM_LANDSAT_PATH=22, ZONE=28, /check)
     proj_limits[*,i]=myMap.uv_box ; normalized uv_box
   endif
endfor


save,filen="projDefinitions.sav",proj,proj_properties,required,optional,proj_scale,proj_limits
end

;soffice --headless --convert-to csv projections.ods
;csv_proj=read_csv("projections.csv",n_table=1) & save,csv_proj,filename="csv.sav" & exit
; gdl
; .compile map_proj_init.pro
; MAP_PROJ_AUXILIARY_READ_CSV
; exit

