#!/usr/bin/perl -w
######################################################################
# This Perl script will generate a geometry file to use
# with IceCube simulations.
# Author: Joakim Edsjo, edsjo@physto.se
# Date: December 29, 1999
######################################################################

use Getopt::Std;

######### SETUP and INPUT ##########

$ver="1.0, December 29, 1999";

### Parse input arguments

getopts('s:o:v:g:p:h',\%opts);

if ($opts{"h"}) {       # Help required
    print<<END;
Usage: gen-square.pl [arguments] [geometry-file]

gen-square.pl generates a geometry file with a square layout. The output is
written to the given geometry file. If no geometry file is given, a default
name is generated.

Arguments:
   -s number  Set the string spacing to <number> meters. Default: 125 m.
   -o number  Number of OMs on each string. Default: 60
   -v number  Vertical spacing between OMs (meters). Default: 16 m.
   -g number  Number of grid points in x and y, i.e. a <number> x <number>
              grid centered around (0,0) will be generated. Default: 9
   -p number  What pulse shape to use. Default: 5 (square pulse)
   -h         Show this help.

Joakim Edsjo, edsjo\@physto.se
END
    die "-- gen-square version $ver --\n";
} 

if ($opts{'s'}) {
    $stringspacing=$opts{'s'};
} else {
    $stringspacing=125;
}

if ($opts{'o'}) {
    $omperstring=$opts{'o'};
} else {
    $omperstring=60;
}

if ($opts{'v'}) {
    $verticalspacing=$opts{'v'};
} else {
    $verticalspacing=16;
}

if ($opts{'g'}) {
    $gridpoints=$opts{'g'};
} else {
    $gridpoints=9;
}

if ($opts{'p'}) {
    $pulseshape=$opts{'p'};
} else {
    $pulseshape=5;
}

if (@ARGV>0) {   # output file given
   $geofile=shift;
} else {         # generate output file name
   $geofile="ice.${gridpoints}_${stringspacing}m.${omperstring}_"
    . "${verticalspacing}m";
   if ($pulseshape == 5) {
       $geofile .= ".sp.geo";
   } else {
       $geofile .= ".${pulseshape}.geo";
   }
   $geofile =~ s/\s+//g;
}

print "Welcome to gen-square.pl\n";
print "Will create the geometry file: $geofile\n";

open(GEO,">$geofile") || 
    die "Can't open geometry file $geofile for writing: $!\n";

geo_header();

$zlow=-($omperstring-1)*$verticalspacing/2;
$xlow=-($gridpoints-1)*$stringspacing/2;
$ylow=-($gridpoints-1)*$stringspacing/2;

$omi=0;
for ($xi=0; $xi<$gridpoints; $xi++) {
    for ($yi=0; $yi<$gridpoints; $yi++) {
        for ($zi=0; $zi<$omperstring; $zi++) {
            $omi++;
	    $x=$xlow+$xi*$stringspacing;
    	    $y=$ylow+$yi*$stringspacing;
            $z=$zlow+$zi*$verticalspacing;
            geo_line($omi,$x,$y,$z);
	}
    }
}


############### SUBROUTINES ###############

sub geo_header {  # Print geomtry file header to output file.
    $date=localtime();
    print GEO <<END;
V 1.20
c ICE^3 geometry created by gen-square.pl version $ver
c Generation date: $date
c Joakim Edsjo, edsjo\@physto.se
c
c
c Explanation of the shortcuts:
c X,Y,Z  : coordinates of OM in [cm]
c TU     : Orientation of OM -1.0 is downlooking, 1.0 is uplooking
c          (no other values possible)
c TH     : Threshold of this channel in [mV]
c 1pe/mV : Position of the 1-pe peak in [mV]
c Hz     : Noise rate of this OM in [Hz]
c m^2    : Projected area (x-y plane) of the OM in [m^2]
c rsens  : Relative sensitivity of PMT to the average PMT
c          (taken from data sheet)
c t0     : Time the signal needs to travel the cable in [ms]
c app    : Probability that an afterpuls will follow the puls
c apdt   : Typical time between puls and afterpulse
c pulse  : Pulse shape number (from puls.txt)
c caladc : Delayed-pulse ADC calibration (1pe/mV) in [mV]
c
c
c rsens, app and apdt are set to educated guesses
c units x,y,z [cm], 1=up, t0=[ns]
c
c#    X       Y       Z    TU  TH  1pe/mV Hz   m^2  rsens  t0  app apdt pulse caladc
END
}

##### 
sub geo_line {  # print one line to the output file
    my ($omi,$x,$y,$z)=@_;
    printf GEO " %i %i. %i. %i. %s %i %s",
    $omi, $x*100, $y*100, $z*100,
    "-1. 100. 322. 500. 0.0444 1. 107. 0.06 6000.",
    $pulseshape,"100.\n";
}