Name

---

      BIT_UNPACK

Purpose

---

      Unpack bit string arrays from a given byte array.

Category

---

Calling Sequence

---

      out = bit_unpack(in,nbits,nwrds)

Inputs

---

      in = Input byte array containing bit string array. in
      nbits = The number of bits in each bit string. in
      nwrds = The number of bit strings. in

Keyword Parameters

---

Keywords

---

        ERROR=err Error flag: 0=ok.
        OUT_BYTES=cbyts Returned # bytes in each output element.

Outputs

---

      out = returned bit strings as an array of integers. out

Common Blocks

---

      bit_unpack_com

Notes

---

      Notes: in may be 1-D (single record) or 2-D (multiple
        records). The bit strings are assumed to start at the
        first bit in the input byte array (which may have more
        bits than are needed, but not less). The output will be
        an array of the smallest unsigned integers that can hold
        the bit strings.

Modification History

---

      R. Sterner, 2011 Sep 06
      R. Sterner, 2012 Feb 22 --- Cleaned up comments.
      R. Sterner, 2012 Jul 27 --- Added OUT_BYTES=cbyts.
  Copyright (C) 2011, Johns Hopkins University/Applied Physics Laboratory
  This software may be used, copied, or redistributed as long as it is not
  sold and this copyright notice is reproduced on each copy made. This
  routine is provided as is without any express or implied warranties
  whatsoever. Other limitations apply as described in the file disclaimer.txt.