1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/*********************************************************************
Functions to interface with DS9 files.
This is part of GNU Astronomy Utilities (Gnuastro) package.
Original author:
Mohammad Akhlaghi <mohammad@akhlaghi.org>
Contributing author(s):
Pedram Ashofteh-Ardakani <pedramardakani@pm.me>
Copyright (C) 2015-2024 Free Software Foundation, Inc.
Gnuastro is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.
Gnuastro is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with Gnuastro. If not, see <http://www.gnu.org/licenses/>.
**********************************************************************/
#include <config.h>
#include <stdio.h>
#include <errno.h>
#include <error.h>
#include <string.h>
#include <stdlib.h>
#include <gnuastro/ds9.h>
#include <gnuastro/data.h>
#include <gnuastro-internal/options.h>
/* Read the polygon specified in the given DS9 region file and parse it in
the standard format. */
gal_data_t *
gal_ds9_reg_read_polygon(char *filename)
{
FILE *fp;
char *polygonstr;
gal_data_t *out=NULL;
size_t i, commacounter=0;
int good_polygon_format=1;
size_t plinelen, linesize=10, lineno=0;
int coordmode=GAL_DS9_COORD_MODE_INVALID;
char *c, *line, *ds9regstart="# Region file format: DS9";
char *polygonformaterr="It is expected for the line to have "
"this format: 'polygon(AAA,BBB,...)'. Where 'AAA' and 'BBB' "
"are numbers and '...' signifies that any number of points "
"are possible";
/* Allocate size to the lines on the file and check if it was sucessfull.
The getline function reallocs the necessary memory. */
errno=0;
line = malloc(linesize * sizeof(*line));
if(line == NULL)
error(EXIT_FAILURE, errno, "%s: %zu bytes for line buffer",
__func__, linesize * sizeof(*line));
/* Open the file and checks if it's not null. */
errno=0;
fp = fopen(filename, "r");
if(fp == NULL)
error(EXIT_FAILURE, errno, "The polygon file is blank");
/* Get the lines on the file. */
while(getline(&line, &linesize, fp)!=-1)
{
/* To have line-counters starting from 1. */
++lineno;
/* The first line should start with a fixed string. */
if(lineno==1)
{
if( strncmp(line, ds9regstart, 25) )
error(EXIT_FAILURE, 0, "%s: doesn't appear to be a DS9 "
"region file! We assume that DS9 region files begin "
"with this string in their first line: '%s'",
filename, ds9regstart);
continue;
}
/* If we are on the coordinate mode line, then set the mode of Crop
based on it. */
if( !strcmp(line, "fk5\n") || !strcmp(line, "image\n") )
{
/* Make sure it hasn't been called more than once. */
if(coordmode!=GAL_DS9_COORD_MODE_INVALID)
error_at_line(EXIT_FAILURE, 0, filename, lineno,
"more than one coordinate line defined");
/* Set the proper mode. */
if(!strcmp(line, "fk5\n")) coordmode=GAL_DS9_COORD_MODE_WCS;
else coordmode=GAL_DS9_COORD_MODE_IMG;
/* Stop parsing the file if the polygon has also been found by
this point (we don't need any more information, no need to
waste the user's CPU and time). */
if(out) break;
}
/* The line containing the polygon information starts with
'polygon('. */
if( !strncmp(line, "polygon(", 8) )
{
/* Get the line length and check if it is indeed in the proper
format. The format is corrupt if we do not find the matching
paranthesis before '#' or the final character. If successful,
set status to '1' and ignore the rest. Here we skip the first
8 characters that contain 'polygon('. */
plinelen=strlen(line);
for(i=8; i<plinelen; ++i)
{
if(line[i]=='#') { good_polygon_format=0; break; }
if(line[i]==')') { line[i]='\0'; break; }
}
/* Check if we have the proper formatting. */
if(good_polygon_format==0)
error_at_line(EXIT_FAILURE, 0, filename, lineno,
"line with polygon vertices couldn't be "
"parsed: no closing parenthesis could be"
"found at the end, or before a '#'. %s",
polygonformaterr);
/* Convert the string to the expected format (with ':' separating
each vertice). Note how we are ignoring the first 8 characters
that contain 'polygon('. */
polygonstr=&line[8];
for(c=polygonstr; *c!='\0'; ++c)
if(*c==',' && (++commacounter % 2) == 0 ) *c=':';
/* Read the coordinates within the line. */
out=gal_options_parse_colon_sep_csv_raw(polygonstr,
filename,
lineno);
/* Stop parsing the file if the coordinate mode has also been
found by this point (we don't need any more information, no
need to waste the user's CPU and time). */
if(coordmode!=GAL_DS9_COORD_MODE_INVALID) break;
}
}
/* If no coordinate mode was found in the file, print an error. */
if(coordmode==GAL_DS9_COORD_MODE_INVALID)
error(EXIT_FAILURE, 0, "%s: no coordinate mode found! "
"We expect one line to be either 'fk5' or 'image'",
filename);
/* If no polygon line was in the file, abort with an error. */
if(out==NULL)
error(EXIT_FAILURE, 0, "%s: no polygon statement found! We expect "
"one line in the format of 'polygon(AAA,BBB,...)' in the "
"file given to '--polygonfile' option. %s", filename,
polygonformaterr);
/* Write the coordinate mode into the status component. */
out->status = coordmode;
/* Clean up and return. */
free(line);
fclose(fp);
return out;
}
|
