Astro:...r::GSD(3pm)

πŸ“¦
version 3.09 Β· 2 versions
  • 3.09 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 3.08 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– Astro::FITS::Header::GSD πŸ’–

okay so bestie, this is a page from the User Contributed Perl Documentation (you know, the 3pm corner of the man universe), and it's all about Astro::FITS::Header::GSD. pull up a chair, we're doing FITS headers today πŸ¦‹


✨ NAME ✨

Astro::FITS::Header::GSD β€” manipulate FITS headers from GSD files πŸ’…


🌸 SYNOPSIS 🌸

  use Astro::FITS::Header::GSD;

  $hdr = new Astro::FITS::Header::GSD( Cards => \@cards );
  $hdr = new Astro::FITS::Header::GSD( gsdobj => $gsd );
  $hdr = new Astro::FITS::Header::GSD( File => $file );

πŸŽ€ DESCRIPTION πŸŽ€

so this module is lowkey a little bridge β€” it uses the Starlink GSD module to read from a GSD header. that's the whole vibe. 🫢

it keeps all the info about a FITS header block inside an object, and when you make one you hand it a hash. in that hash you can put either:

  • an array reference pointing at an array of FITS header cards, or
  • a filename, or
  • alternatively, a GSD object

pick your fighter, bestie. ✨


πŸ‘‘ METHODS πŸ‘‘

πŸ’œ configure

reads a header from a GSD file. iconic behaviour, honestly.

  $hdr->configure( Cards => \@cards );
  $hdr->configure( Items => \@items );
  $hdr->configure( gsdobj => $gsd );
  $hdr->configure( File => $filename );

it accepts a GSD object or a filename. and IMPORTANT, no cap: if both the gsdobj and File keys are hanging out in there, the gsdobj key takes priority. she's the main character, the other one is just vibing. πŸ’…

πŸ’œ writehdr

the GSD library is read-only, bestie. 😭 the writehdr method is not implemented for this sub-class. it's giving "no thoughts, no writes." don't come for her, she literally cannot.

🌈 NOTES 🌈

  • this module requires the Starlink GSD module. non-negotiable, fr fr.
  • GSD supports keys that are longer than the 8 characters allowed as part of the FITS standard. but GSD keys get truncated to 8 characters by this module. so if your key was feeling extra long... yeah, she's getting snipped to 8. that's just how it is. πŸ’€

πŸ¦‹ SEE ALSO πŸ¦‹

  • NDF
  • Astro::FITS::Header
  • Astro::FITS::Header::Item
  • Astro::FITS::Header::CFITSIO
  • Astro::FITS::Header::NDF

go read those next, bestie, they're the extended universe. πŸ“šβœ¨


🫢 AUTHORS 🫢

  • Tim Jenness <t.jenness@jach.hawaii.edu>
  • Alasdair Allan <aa@astro.ex.ac.uk>

legends. ate. πŸ‘‘


Copyright (C) 2008-2011 Science & Technology Facilities Council.

Copyright (C) 2001-2002 Particle Physics and Astronomy Research Council.

All Rights Reserved.

okay so the legal bit, and it's important so read it properly:

this program 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.

this program 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 this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA


and that's the whole page, bestie!! πŸŽ‰βœ¨πŸ’–

this little love letter to your terminal came courtesy of perl v5.36.0, dated 2023-04-21, living under the name Astro:...r::GSD(3pm). go forth and read your GSD headers. slay. πŸ’…πŸŒΈπŸ¦‹