jyapayne/glymur
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'issue11' into devel

Browse source 
Conflicts:
	docs/source/introduction.rst
This commit is contained in:
jevans 2013-06-05 20:46:10 -04:00
commit 56e76aac03
11 changed files with 667 additions and 61 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/source/api.rst
View file

@ -1,5 +1,6 @@
---
API
===
---
Jp2k
----

2
docs/source/conf.py
View file

@ -78,7 +78,7 @@ copyright = u'2013, John Evans'
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1.3p1'
release = '0.1.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

12
docs/source/how_do_i.rst
View file

@ -1,6 +1,6 @@
************
------------
How do I...?
************
------------
Get the code?
=============
@ -12,7 +12,7 @@ Go to either of
Display metadata?
=================
There are two ways. From the unix command line, the script **jp2dump** is
There are two ways. From the unix command line, the script *jp2dump* is
available. ::
$ jp2dump /path/to/glymur/installation/data/nemo.jp2
@ -25,9 +25,9 @@ From within Python, it is as simple as printing the Jp2k object, i.e. ::
>>> j = Jp2k(file)
>>> print(j)
The primary emphasis is on JP2 metadata, but it is possible to
display just raw codestream as well. This will display metadata present in the
codestream's main header only. ::
This prints the metadata found in the JP2 boxes, but in the case of the
codestream box, only the main header is printed. It is possible to print
**only** the codestream information as well, i.e. ::
>>> print(j.get_codestream())

7
docs/source/index.rst
View file

@ -3,8 +3,9 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
==================================
Welcome to glymur's documentation!
===================================
==================================
Contents:
@ -16,9 +17,9 @@ Contents:
how_do_i
roadmap
------------------
Indices and tables
==================
------------------
* :ref:`genindex`
* :ref:`modindex`

22
docs/source/introduction.rst
View file

@ -1,6 +1,6 @@
=========================================
----------------------------------------
Glymur: a Python interface for JPEG 2000
=========================================
----------------------------------------
**Glymur** contains a Python interface to the OpenJPEG library
which allows linux and mac users to read and write JPEG 2000 files. For more
@ -13,15 +13,15 @@ Glymur supports both reading and writing of JPEG 2000 images (part 1). Writing
JPEG 2000 images is currently limited to images that can fit in memory,
however.
Of particular focus is retrieval of metadata. Reading XMP UUID boxes
is supported, as the data block consists of an XMP packet, which is
just XML. There is some very limited support for reading JPX metadata.
For instance, *asoc* and *labl* boxes are recognized, so GMLJP2 metadata
can be retrieved from such JPX files.
Of particular focus is retrieval of metadata. Reading Exif UUIDs is supported,
as is reading XMP UUIDs as the XMP data packet is just XML. There is
some very limited support for reading JPX metadata. For instance,
**asoc** and **labl** boxes are recognized, so GMLJP2 metadata can
be retrieved from such JPX files.
------------
''''''''''''
Requirements
------------
''''''''''''
glymur works on Python 2.7 and 3.3. Python 3.3 is strongly recommended.
OpenJPEG
@ -133,9 +133,9 @@ Windows
-------
Not currently supported.
------------------------------------
''''''''''''''''''''''''''''''''''''
Installation, Testing, Configuration
------------------------------------
''''''''''''''''''''''''''''''''''''
From this point forward, python3 will be referred to as just "python".

5
docs/source/roadmap.rst
View file

@ -1,9 +1,10 @@
-------
Roadmap
=======
-------
Here's an incomplete list of what I'd like to focus on in the near future.
* continue to monitor upstream changes in the **openjp2** library
* add read support or Exif UUIDs
* investigate using CFFI or cython instead of ctypes to wrap **openjp2**
* add read support for ICC profiles