fitstopnm, pamcut, pamdeinterlace, pamdice, pammixinterlace, pamtofits, pamundice, pnmtofits: add pages (#12296)

* fitstopnm, pamcut, pamdeinterlace, pamdice, pammixinterlace, pamtofits, pamundice, pnmtofits: add pages

* Apply suggestions from code review

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>

* Update pages/common/pamdice.md

* Update pages/common/fitstopnm.md

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>

* Update pages/common/fitstopnm.md

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>

* Update pages/common/pamundice.md

---------

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
pull/23/head
Juri Dispan 2024-02-22 16:23:38 +01:00 committed by GitHub
parent 70e20af84f
commit acafa88054
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 107 additions and 0 deletions

13
pages/common/fitstopnm.md Normal file
View File

@ -0,0 +1,13 @@
# fitstopnm
> Convert a Flexible Image Transport System (FITS) file to a PNM image.
> See also: `pamtofits`.
> More information: <https://netpbm.sourceforge.net/doc/fitstopnm.html>.
- Convert a FITS file to a PNM image:
`fitstopnm {{path/to/file.fits}} > {{path/to/output.pnm}}`
- Convert the image on the specified position of the third axis in the FITS file:
`fitstopnm -image {{z_position}} {{path/to/file.fits}} > {{path/to/output.pnm}}`

17
pages/common/pamcut.md Normal file
View File

@ -0,0 +1,17 @@
# pamcut
> Cut out a rectangular region from a Netpbm image.
> See also: `pamcrop`, `pamdice`, `pamcomp`.
> More information: <https://netpbm.sourceforge.net/doc/pamcut.html>.
- Discard the specified number of columns/rows on each side of the image:
`pamcut -cropleft {{value}} -cropright {{value}} -croptop {{value}} -cropbottom {{value}} {{path/to/image.ppm}} > {{path/to/output.ppm}}`
- Keep only the columns between the specified columns (inclusively):
`pamcut -left {{value}} -right {{value}} {{path/to/image.ppm}} > {{path/to/output.ppm}}`
- Fill missing areas with black pixels if the specified rectangle does not entirely lie within the input image:
`pamcut -top {{value}} -bottom {{value}} -pad {{path/to/image.ppm}} > {{path/to/output.ppm}}`

View File

@ -0,0 +1,13 @@
# pamdeinterlace
> Remove every other row in a Netpbm image.
> See also: `pammixinterlace`.
> More information: <https://netpbm.sourceforge.net/doc/pamdeinterlace.html>.
- Produce an image consisting of the input's even-numbered rows:
`pamdeinterlace {{path/to/image.ppm}} > {{path/to/output.ppm}}`
- Produce an image consisting of the input's odd-numbered rows:
`pamdeinterlace -takeodd {{path/to/image.ppm}} > {{path/to/output.ppm}}`

13
pages/common/pamdice.md Normal file
View File

@ -0,0 +1,13 @@
# pamdice
> Slice a Netpbm image vertically or horizontally.
> See also: `pamundice`.
> More information: <https://netpbm.sourceforge.net/doc/pamdice.html>.
- Slice a Netpbm image such that the resulting tiles have the specified height and width:
`pamdice -outstem {{path/to/filename_stem}} -height {{value}} -width {{value}} {{path/to/input.ppm}}`
- Make the produced pieces overlap by the specified amount horizontally and vertically:
`pamdice -outstem {{path/to/filename_stem}} -height {{value}} -width {{value}} -hoverlap {{value}} -voverlap {{value}} {{path/to/input.ppm}}`

View File

@ -0,0 +1,17 @@
# pammixinterlace
> Merge each row in an image with its two neighbours.
> See also: `pamdeinterlace`.
> More information: <https://netpbm.sourceforge.net/doc/pammixinterlace.html>.
- Merge each row in an image with its two neighbours:
`pammixinterlace {{path/to/image.ppm}} > {{path/to/output.ppm}}`
- Use the specified filtering mechanism:
`pammixinterlace -filter {{linear|fir|ffmpeg}} {{path/to/image.ppm}} > {{path/to/output.ppm}}`
- Turn on adaptive filtering mode, i.e., only modify pixels that are obviously part of a comb pattern:
`pammixinterlace -adaptive {{path/to/image.ppm}} > {{path/to/output.ppm}}`

View File

@ -0,0 +1,9 @@
# pamtofits
> Convert a Netpbm image to the Flexible Image Transport System (FITS) format.
> See also: `fitstopnm`.
> More information: <https://netpbm.sourceforge.net/doc/pamtofits.html>.
- Convert a Netpbm image to the FITS format:
`pamtofits {{path/to/image.pam}} > {{path/to/output.fits}}`

17
pages/common/pamundice.md Normal file
View File

@ -0,0 +1,17 @@
# pamundice
> Combine a grid of Netpbm images into one.
> See also: `pamdice`.
> More information: <https://netpbm.sourceforge.net/doc/pamundice.html>.
- Combine the images whose names match the `printf`-style filename expression. Assume a grid with a specific size:
`pamundice {{filename_%1d_%1a.ppm}} -across {{grid_width}} -down {{grid_height}} > {{path/to/output.ppm}}`
- Assume that the tiles overlap horizontally and vertically by the specified amount:
`pamundice {{filename_%1d_%1a.ppm}} -across {{x_value}} -down {{y_value}} -hoverlap {{value}} -voverlap {{value}} > {{path/to/output.ppm}}`
- Specify the images to be combined through a text file containing one filename per line:
`pamundice -listfile {{path/to/file.txt}} -across {{x_value}} -down {{y_value}} > {{path/to/output.ppm}}`

View File

@ -0,0 +1,8 @@
# pnmtofits
> This command is superseded by `pamtofits`.
> More information: <https://netpbm.sourceforge.net/doc/pnmtofits.html>.
- View documentation for the current command:
`tldr pamtofits`