org.deeplearning4j.scalnet.layers.reshaping.Unflatten3D.scala Maven / Gradle / Ivy

Go to download
/*
 *
 *  * Copyright 2016 Skymind,Inc.
 *  *
 *  *    Licensed under the Apache License, Version 2.0 (the "License");
 *  *    you may not use this file except in compliance with the License.
 *  *    You may obtain a copy of the License at
 *  *
 *  *        http://www.apache.org/licenses/LICENSE-2.0
 *  *
 *  *    Unless required by applicable law or agreed to in writing, software
 *  *    distributed under the License is distributed on an "AS IS" BASIS,
 *  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  *    See the License for the specific language governing permissions and
 *  *    limitations under the License.
 *
 */

package org.deeplearning4j.scalnet.layers.reshaping

import org.deeplearning4j.nn.conf.InputPreProcessor
import org.deeplearning4j.nn.conf.preprocessor.FeedForwardToCnnPreProcessor
import org.deeplearning4j.scalnet.layers.Node
import org.deeplearning4j.scalnet.layers.Preprocessor


/**
  * Unflattens vector into structured image-like output. Input must be a
  * vector while output should have three dimensions: height (number of rows),
  * width (number of columns), and number of channels.
  *
  * @author David Kale
  */
class Unflatten3D(
    newOutputShape: List[Int],
    nIn: Int = 0)
  extends Node with Preprocessor {
  if (newOutputShape.length != 3)
    throw new IllegalArgumentException("New output shape must be length 3.")
  _outputShape = newOutputShape
  inputShape = List(nIn)

  override def compile: InputPreProcessor = {
    if (inputShape.isEmpty || (inputShape.length == 1 && inputShape.head == 0))
      throw new IllegalArgumentException("Input shape must be nonempty and nonzero.")
    if (inputShape.last != outputShape.product)
      throw new IllegalStateException("Overall output shape must be equal to original input shape.")

    new FeedForwardToCnnPreProcessor(outputShape.head, outputShape.tail.head, outputShape.last)
  }
}