1Panotools::Script(3) User Contributed Perl Documentation Panotools::Script(3)
2
6 Panotools::Script - Panorama Tools scripting
7
9 Read, write and manipulate hugin script files.
10
12 Library and utilities for manipulating project files created by the
13 hugin photo stitching software.
14 This file format is shared with various other tools, in particular this
16 module is also capable of working with Panorama Tools script files.
17
19 my $p = new Panotools::Script;
20 $p->Read ('/path/to/script.txt');
22 $p->Write ('/path/to/script.txt');
24 File paths in a Panorama Tools script file are generally relative to
26 the directory containing the script. Modify this or otherwise prefix
27 the filenames by supplying an optional second argument:
28 $p->Write ('/path/to/script.txt', '../path/to/prefix/tofiles');
30 Clone a script object
32 $clone = $p->Clone;
34 Access various sections of the scriptfile:
36 $p->Mode; # a L<Panotools::Script::Line::Mode> object
38 $p->Panorama; # a L<Panotools::Script::Line::Panorama> object
39 $p->Variable; # a L<Panotools::Script::Line::Variable> object
40 $p->Image; # an array of L<Panotools::Script::Line::Image> objects
42 $p->Output; # an array of L<Panotools::Script::Line::Output> objects
43 $p->Control; # an array of L<Panotools::Script::Line::Control> objects
44 $p->ControlMorph; # an array of L<Panotools::Script::Line::ControlMorph> objects
45 Rotate transform all the images in a project, angles in degrees:
47 $p->Transform ($roll, $pitch, $yaw);
49 'o' output lines are generated by PTOptimizer and contain stitching
51 parameters for each input image. 'i' image lines provide parameters
52 for optimisation as well as stitching.
53 Update the 'image' lines based on 'output' lines and vice-versa like
55 so:
56 $p->Output2Image;
58 $p->Image2Output;
59 Remove duplicate control points from the project, returns a list of
61 deleted points:
62 my $deleted = $p->Duplicates;
64 Remove all points with an error distance greater than a threshold
66 measured in pixels, returns a list of deleted points:
67 my $pruned = $p->Prune (12.345);
69 Extract a new object consisting of just the requested images, related
71 control points and optimisation settings:
72 my $subset = $p->Subset (1, 2, 34, 56);
74 Images can be requested in any order, but they will be returned in the
76 same order as the 'parent' project.
77 Merge a project with another:
79 $p->Merge ($newstuff);
81 This adds extra images from $newstuff, skipping duplicates. All
83 control points except exact duplicates are imported regardless.
84 Get a summary of control point error distances in pixel units scaled to
86 the output panorama:
87 my ($total, $min, $max, $average, $sigma) = $p->Stats;
89 Centre input images into the final panorama:
91 $p->Centre ('y');
93 $p->Centre ('p');
94 $p->Centre ('r');
95 Split the project into exposure stacks based in roll, pitch & yaw, or
97 into exposure layers based on EV values:
98 $stacks = $pto->Stacks;
100 $layers = $pto->ExposureLayers;
101 Returns a list of image number lists.
103 e.g. extract the first stack as a new project:
105 $pto_stack = $pto->Subset (@{$pto->Stacks->[0]});
107 Split a project into exposure layers, returns a list of lists of image
109 ids:
110 my $layers = $pto->ExposureLayers (1.0);
112 Deafults to 0.5EV difference threshold.
114 Get a list of unconnected groups, i.e. a list of image id lists:
116 $groups = $pto->ConnectedGroups;
118 warn 'just one group' if scalar @{$groups} == 1;
120 Count the connections between any two images:
122 $points = $pto->Connections (3, 5);
124 Given a project with unlinked lens parameters, link them together with
126 the same lens number if all distortion, and photometric parameters
127 match:
128 $pto->UnifyLenses;
130 Given a project with stacks indicated by 'j' parameters, hard-link the
132 positions (only recognised by Hugin with layout mode code).
133 $pto->LinkStacks;
135 Return the angular distance in degrees between two images:
137 $deg = $pto->AngularDistance (3, 5);
139 Look at all photos and calculate an optimal pixel width for this
141 panorama, optionally supply a scaling factor:
142 $width = $pto->OptimalWidth (0.7);
144 This number is rounded up to the nearest multiple of 16 pixels.
146 Hugin ships with a tool called pano_trafo for querying the forward and
148 reverse transform for pixel coordinates in a PTO project.
149 Initialise this as a service, spawns two pano_trafo processes which are
151 only killed when the perl process finishes:
152 $pto->InitTrafo ('/path/to/project.pto');
154 This is very unlikely to work on non-unixy systems.
156 Query the forward transform like so:
158 ($X, $Y) = $pto->Trafo ($image_no, $x, $y);
160 Query the reverse transform like so:
162 ($x, $y) = $pto->TrafoReverse ($image_no, $X, $Y);
164
166 Copyright (c) 2001 Bruno Postle <bruno@postle.net>. All Rights
167 Reserved.
168 This program is free software; you can redistribute it and/or modify it
170 under the terms of the GNU General Public License as published by the
171 Free Software Foundation; either version 2 of the License, or (at your
172 option) any later version.
173 This software is distributed in the hope that it will be useful, but
175 WITHOUT ANY WARRANTY; without even the implied warranty of
176 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
177 General Public License for more details.
178 You should have received a copy of the GNU General Public License along
180 with this software; if not, write to the Free Software Foundation,
181 Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
182perl v5.34.0 2021-07-22 Panotools::Script(3)